oracle.ecsf.meta
Interface FieldDefinition

public interface FieldDefinition

Field definition interface.

Method Summary

java.lang.String	getBinding() Returns the binding name of this definition.
float	getBoost() Returns a boost value for this field.
java.lang.String	getColumnName() Returns the column name of this definition.
java.lang.String	getColumnNameForQuery() Returns the column name for query including table alias.
java.lang.String	getDataType() Returns data type of this field.
java.lang.String	getDisplayName() Returns display name of this field.
java.lang.String	getDisplayName(java.util.Locale locale) Returns display name of this field.
java.lang.String	getName() Returns the name of this definition.
java.lang.String	getSearchEngineDataType() Returns data type of this field as stored on the search engine.
boolean	isDateBased() Tests if this field will be used for incremental crawling.
boolean	isFacetField() Tests whether this field is a facet stored field.
boolean	isGrant() Returns true if the field definition is used as secure attribute of type grant, false means type of deny.
boolean	isLanguageField() whether this field denotes the language of the document
boolean	isPrimaryKey() Tests whether this field is part of primary key
boolean	isSecure() Tests whether this is field is a secure field.
boolean	isStored() Tests whether this field is stored.

Method Detail

getName

java.lang.String getName()

Returns the name of this definition.

Returns:

name of the field.

getDisplayName

java.lang.String getDisplayName(java.util.Locale locale)

Returns display name of this field. It should be normally human readable form, and i18nized.

Parameters:

locale -

Returns:

name of the field.

getDisplayName

java.lang.String getDisplayName()

Returns display name of this field. It should be normally human readable form, and i18nized. The locale of the search context will be used.

Returns:

name of the field.

isSecure

boolean isSecure()

Tests whether this is field is a secure field. If it is, its value will be used for security filtering.

Returns:

true if test positive.

isStored

boolean isStored()

Tests whether this field is stored.

Returns:

true if it is stored.

isFacetField

boolean isFacetField()

Tests whether this field is a facet stored field.

Returns:

true if it is a facet stored.

getBoost

float getBoost()

Returns a boost value for this field. Value 1 means neutrual. A larger value indicates this field weighs more than ones that has a small value. Default value is 1.

Returns:

boost value for this field.

isPrimaryKey

boolean isPrimaryKey()

Tests whether this field is part of primary key

getDataType

java.lang.String getDataType()

Returns data type of this field.

Returns:

data type.

getSearchEngineDataType

java.lang.String getSearchEngineDataType()

Returns data type of this field as stored on the search engine.

Returns:

data type.

isDateBased

boolean isDateBased()

Tests if this field will be used for incremental crawling.

isLanguageField

boolean isLanguageField()

whether this field denotes the language of the document

getBinding

java.lang.String getBinding()

Returns the binding name of this definition.

Returns:

binding name of the field.

getColumnName

java.lang.String getColumnName()

Returns the column name of this definition.

Returns:

column name of the field.

getColumnNameForQuery

java.lang.String getColumnNameForQuery()

Returns the column name for query including table alias.

Returns:

column name for query

isGrant

boolean isGrant()

Returns true if the field definition is used as secure attribute of type grant, false means type of deny. This value is used to govern the behavior of the ACL by SES.

Returns:

true if it is secure type of grant.