oracle.ecsf.meta
Interface DocumentDefinition

public interface DocumentDefinition

Decuement definition for a search engine. This is the base entity a search engine works with.

Field Summary

static java.lang.String	ECSF_ACTION_TITLE Reserved column name for ECSF default action title
static java.lang.String	ECSF_LAST_MODIFIED_DATE Reserved column name for ECSF last modified date
static java.lang.String	ECSF_SO_NAME Reserved column name for ECSF searchable object name
static java.lang.String	ECSF_TAGS Reserved column name for ECSF tags

Method Summary

void	addField(FieldDefinition field) Adds a field to this document.
java.util.Collection<DocumentDefinition>	getDocuments() Returns sub documents for this document.
java.util.Collection<FieldDefinition>	getFields() Returns field definitions for this document.
java.lang.String	getFullName() Returns the name for this definition.
java.lang.String	getSelectStatement(IndexableDocument parentDoc) Returns select statement that will be used to select data fro crawling.

Field Detail

ECSF_SO_NAME

static final java.lang.String ECSF_SO_NAME

Reserved column name for ECSF searchable object name

See Also:

Constant Field Values

ECSF_TAGS

static final java.lang.String ECSF_TAGS

Reserved column name for ECSF tags

See Also:

Constant Field Values

ECSF_ACTION_TITLE

static final java.lang.String ECSF_ACTION_TITLE

Reserved column name for ECSF default action title

See Also:

Constant Field Values

ECSF_LAST_MODIFIED_DATE

static final java.lang.String ECSF_LAST_MODIFIED_DATE

Reserved column name for ECSF last modified date

See Also:

Constant Field Values

Method Detail

getFields

java.util.Collection<FieldDefinition> getFields()

Returns field definitions for this document.

Returns:

field definitions

getDocuments

java.util.Collection<DocumentDefinition> getDocuments()

Returns sub documents for this document.

Returns:

sub documents.

addField

void addField(FieldDefinition field)

Adds a field to this document. Used internally by the designer/loader to construct a new field to this document.

Parameters:

field -

getSelectStatement

java.lang.String getSelectStatement(IndexableDocument parentDoc)

Returns select statement that will be used to select data fro crawling.

Parameters:

parentDoc - parent document instance. Null if this is a root document.

Returns:

a valid select statment

getFullName

java.lang.String getFullName()

Returns the name for this definition.

Returns: