org.apache.stanbol.entityhub.servicesapi
Interface EntityhubConfiguration

public interface EntityhubConfiguration

Provides the Configuration needed by the Entityhub.

Author:

Rupert Westenthaler

Field Summary

static String	DEFAULT_ENTITYHUB_YARD_ID The default ID for the Yard used for the Entityhub
static String	DEFAULT_MAPPING_STATE The property used to configure the initial state for new EntityMappings
static String	DEFAULT_SYMBOL_STATE The property used to configure the initial state for new Symbols
static String	DESCRIPTION The key used to configure the description of the entity hub
static String	ENTITYHUB_YARD_ID The property used to configure the id of the Yard used to store the data of the Entityhub
static String	FIELD_MAPPINGS The property used to configure the field mappings for the Entityhub
static String	ID The key used to configure the ID of the entity hub
static String	NAME The key used to configure the name of the entity hub
static String	PREFIX The property used to configure the prefix used for Symbols and EntityMappings created by the Entityhub

Method Summary

ManagedEntityState	getDefaultManagedEntityState() The initial (default) state for new Symbols
MappingState	getDefaultMappingState() The initial (default) state for new EntityMappings
String	getDescription() The human readable description to provide some background information about this entity hub instance.
String	getEntityhubPrefix() Getter for the Prefix to be used for all Symbols and EntityMappings created by the Entityhub
String	getEntityhubYardId() This is the ID of the Yard used by the Entityhub to store its data
Collection<String>	getFieldMappingConfig() Getter for the FieldMapping configuration of the Entityhub.
String	getID() The ID of the Entityhub.
String	getName() The human readable name of this entity hub instance.

Field Detail

ID

static final String ID

The key used to configure the ID of the entity hub

See Also:

Constant Field Values

PREFIX

static final String PREFIX

The property used to configure the prefix used for Symbols and EntityMappings created by the Entityhub

See Also:

Constant Field Values

NAME

static final String NAME

The key used to configure the name of the entity hub

See Also:

Constant Field Values

DESCRIPTION

static final String DESCRIPTION

The key used to configure the description of the entity hub

See Also:

Constant Field Values

ENTITYHUB_YARD_ID

static final String ENTITYHUB_YARD_ID

The property used to configure the id of the Yard used to store the data of the Entityhub

See Also:

Constant Field Values

DEFAULT_ENTITYHUB_YARD_ID

static final String DEFAULT_ENTITYHUB_YARD_ID

The default ID for the Yard used for the Entityhub

See Also:

Constant Field Values

FIELD_MAPPINGS

static final String FIELD_MAPPINGS

The property used to configure the field mappings for the Entityhub

See Also:

Constant Field Values

DEFAULT_MAPPING_STATE

static final String DEFAULT_MAPPING_STATE

The property used to configure the initial state for new EntityMappings

See Also:

Constant Field Values

DEFAULT_SYMBOL_STATE

static final String DEFAULT_SYMBOL_STATE

The property used to configure the initial state for new Symbols

See Also:

Constant Field Values

Method Detail

getID

String getID()

The ID of the Entityhub. This ID is used as origin (sign site) for all symbols and mapped entities created by the Entityhub

Returns:

the ID of the Entityhub

getEntityhubPrefix

String getEntityhubPrefix()

Getter for the Prefix to be used for all Symbols and EntityMappings created by the Entityhub

Returns:

The prefix for Symbols and EntityMappings

getName

String getName()

The human readable name of this entity hub instance. Typically used as label in addition/instead of the ID.

Returns:

the Name (or the ID in case no name is defined)

getDescription

String getDescription()

The human readable description to provide some background information about this entity hub instance.

Returns:

the description or null if none is defined/configured.

getEntityhubYardId

String getEntityhubYardId()

This is the ID of the Yard used by the Entityhub to store its data

Returns:

the entity hub yard id

getFieldMappingConfig

Collection<String> getFieldMappingConfig()

Getter for the FieldMapping configuration of the Entityhub. These Mappings are used for every ReferencedSite of the Entityhub.
Note that FieldMapping#parseFieldMapping(String) is used to parsed the values returned by this Method

Returns:

the configured mappings for the Entityhub

getDefaultMappingState

MappingState getDefaultMappingState()

The initial (default) state for new EntityMappings

Returns:

the default state for new EntityMappings

getDefaultManagedEntityState

ManagedEntityState getDefaultManagedEntityState()

The initial (default) state for new Symbols

Returns:

the default state for new Symbols