Skip navigation links

oracle.search.sdk.crawler
Interface LovInfo

public interface LovInfo

LovInfo is an interface used by both the crawler and a data source plugin to set and retrieve attribute lists of values (LOV) from the data source.

Field Summary

static int	ATTR_DATE Date attribute data types
static int	ATTR_NUMBER Number attribute data types
static int	ATTR_STRING String attribute data types

Method Summary

void	addAttributeValue(String name, BigDecimal value) Adds an attribute value whose data type is Number.
void	addAttributeValue(String name, BigDecimal value, String displayName, String langCode) Add an attribute value and display name whose data type is Number.
void	addAttributeValue(String name, Date value) Add an attribute value whose data type is java.sql.Date.
void	addAttributeValue(String name, Date value, String displayName, String langCode) Add an attribute value and display name whose type is java.sql.Date
void	addAttributeValue(String name, String value) Add an attribute value whose data type is String.
void	addAttributeValue(String name, String value, String displayName, String langCode) Adds an attribute value and display name whose data type is String
void	clearData() Clear all LOV data
Enumeration	getAttributeLov(int attrIndex) Gets the list of values for a specified attribute.
String	getAttributeName(int attrIndex) Gets the name of the specified attribute.
int	getAttributeType(int attrIndex) Gets the data type of the specified attribute.
Enumeration	getDisplayNames(int attrIndex, int langIndex) Gets the list of display names for a specified attribute.
String	getLangCode(int attrIndex, int langIndex) Gets the language-country code string for a display name.
int	getNumAttributes() Gets number of attributes.
int	getNumAttrValues() Gets number of attribute values.
int	getNumDisplayNames(int attrIndex, int langIndex) Gets number of display names of an attribute in a particular language.
int	getNumLanguages(int attrIndex) Gets the number of languages available for the display name of an attribute.

Field Detail

ATTR_STRING

static final int ATTR_STRING

String attribute data types

See Also:

Constant Field Values

ATTR_NUMBER

static final int ATTR_NUMBER

Number attribute data types

See Also:

Constant Field Values

ATTR_DATE

static final int ATTR_DATE

Date attribute data types

See Also:

Constant Field Values

Method Detail

addAttributeValue

void addAttributeValue(String name,
                       BigDecimal value)

Adds an attribute value whose data type is Number.

Parameters:

name - - The name of the attribute

value - - The value of the attribute

addAttributeValue

void addAttributeValue(String name,
                       Date value)

Add an attribute value whose data type is java.sql.Date.

Parameters:

name - - The name of the attribute

value - - The value of the attribute

addAttributeValue

void addAttributeValue(String name,
                       String value)

Add an attribute value whose data type is String.

Parameters:

name - - The name of the attribute

value - - The value of the attribute

addAttributeValue

void addAttributeValue(String name,
                       BigDecimal value,
                       String displayName,
                       String langCode)

Add an attribute value and display name whose data type is Number.

Parameters:

name - - The name of the attribute.

value - - The value of the attribute.

displayName - - The display name of the attribute.

langCode - - The ISO 639-1 language code and ISO3166 country code, for example, "en-US".

addAttributeValue

void addAttributeValue(String name,
                       Date value,
                       String displayName,
                       String langCode)

Add an attribute value and display name whose type is java.sql.Date

Parameters:

name - - The name of the attribute.

value - - The value of the attribute.

displayName - - The display name of the attribute.

langCode- - The ISO 639-1 language code and ISO3166 country code, for example, "en-US".

addAttributeValue

void addAttributeValue(String name,
                       String value,
                       String displayName,
                       String langCode)

Adds an attribute value and display name whose data type is String

Parameters:

name - - The name of the attribute.

value - - The value of the attribute.

displayName - - The display name of the attribute.

langCode - - The ISO 639-1 language code and ISO3166 country code, for example, "en-US".

getNumAttributes

int getNumAttributes()

Gets number of attributes.

Returns:

The number of attributes stored in this object.

getNumAttrValues

int getNumAttrValues()

Gets number of attribute values.

Returns:

The number of attribute values stored in this object.

getAttributeName

String getAttributeName(int attrIndex)

Gets the name of the specified attribute.

Parameters:

attrIndex - - A 0-based index indicating which attribute.

Returns:

The name of the specified attribute.

getAttributeType

int getAttributeType(int attrIndex)

Gets the data type of the specified attribute.

Parameters:

attrIndex - - A 0-based index identifying attribute.

Returns:

The data type of the specified attribute: ATTR_INT, ATTR_STR, or ATTR_DATE.

getAttributeLov

Enumeration getAttributeLov(int attrIndex)

Gets the list of values for a specified attribute.

Parameters:

attrIndex - - A 0-based index identifying the attribute.

Returns:

An enumeration of objects containing attribute values.

getNumLanguages

int getNumLanguages(int attrIndex)

Gets the number of languages available for the display name of an attribute.

Parameters:

attrIndex - - A 0-based index indicating which attribute.

Returns:

number of languages.

getLangCode

String getLangCode(int attrIndex,
                   int langIndex)

Gets the language-country code string for a display name.

Parameters:

attrIndex - - A 0-based index identifying the attribute.

langIndex - - A 0-based index identifying the language.

Returns:

The language code string.

getNumDisplayNames

int getNumDisplayNames(int attrIndex,
                       int langIndex)

Gets number of display names of an attribute in a particular language.

Parameters:

attrIndex - - A 0-based index indicating which attribute.

langIndex - - A 0-based index indicating which language.

Returns:

The number of display names.

getDisplayNames

Enumeration getDisplayNames(int attrIndex,
                            int langIndex)

Gets the list of display names for a specified attribute.

Parameters:

attrIndex - - A 0-based index identifying the attribute.

langIndex - - A 0-based index identifying the language.

Returns:

An enumeration of objects containing display names.

clearData

void clearData()

Clear all LOV data

Skip navigation links