org.imixs.registry.index

Class RegistrySchemaService

java.lang.Object

org.imixs.registry.index.RegistrySchemaService

All Implemented Interfaces:

Serializable

public class RegistrySchemaService
extends Object
implements Serializable

The RegistrySchemaService provides schema informations used by the Imixs-Registry Solr Index.

Version:

1.0

Author:

rsoika

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	DEFAULT_REGISTRY_FIELD_LIST

Constructor Summary

Constructors

Constructor and Description
RegistrySchemaService()

Method Summary

Modifier and Type	Method and Description
String	adaptImixsItemName(String itemName) This method adapts an Imixs item name to the corresponding Solr field name.
String	adaptQueryFieldNames(String _query) This method adapts a search query for Imixs Item names and adapts these names with the corresponding Solr field name (replace $ with _)
String	adaptSolrFieldName(String itemName) This method adapts an Solr field name to the corresponding Imixs Item name.
List<String>	getRegistryCustomFieldList() Returns a list of all custom fields to be stored in the registry schema.
Set<String>	getSchemaFieldList() Returns a unique list of all fields part of the index schema.
void	init() Create a solr rest client instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_REGISTRY_FIELD_LIST

public static List<String> DEFAULT_REGISTRY_FIELD_LIST

Constructor Detail

RegistrySchemaService

public RegistrySchemaService()

Method Detail

init

@PostConstruct
public void init()

Create a solr rest client instance

Throws:

org.imixs.workflow.services.rest.RestAPIException

getRegistryCustomFieldList

public List<String> getRegistryCustomFieldList()

Returns a list of all custom fields to be stored in the registry schema.

NOTE: this list does not contain the core fields '$uniqueid' and '$readaccess'. Use the method getSchmeaFieldList() to get all fields defined by the schema.

Returns:

getSchemaFieldList

public Set<String> getSchemaFieldList()

Returns a unique list of all fields part of the index schema. This list also includes the fields $uniqueid and $readaccess

Returns:

adaptQueryFieldNames

public String adaptQueryFieldNames(String _query)

This method adapts a search query for Imixs Item names and adapts these names with the corresponding Solr field name (replace $ with _)

Returns:

adaptSolrFieldName

public String adaptSolrFieldName(String itemName)

This method adapts an Solr field name to the corresponding Imixs Item name. Because Solr does not accept $ char at the beginning of an field we need to replace starting _ with $ if the item is part of the Imixs Index Schema.

Parameters:

itemName -

Returns:

adapted Imixs item name

adaptImixsItemName

public String adaptImixsItemName(String itemName)

This method adapts an Imixs item name to the corresponding Solr field name. Because Solr does not accept $ char at the beginning of an field we need to replace starting $ with _ if the item is part of the Imixs Index Schema.

Parameters:

itemName -

Returns:

adapted Solr field name