Skip navigation links

oracle.search.query.webservice.client
Class ClusterAttribute

java.lang.Object
oracle.search.query.webservice.client.ClusterAttribute

All Implemented Interfaces:

Serializable

public class ClusterAttribute

extends Object

implements Serializable

See Also:

Serialized Form

Constructor Summary

ClusterAttribute()

ClusterAttribute(String attributeName, String attributeType, String tokenizationDelimiter, String hierarchyDelimiter, Boolean isTokenized, Boolean isHierarchy)
Creates a ClusterAttribute.

Method Summary

String	getAttributeName() Returns the attribute name used for clustering.
String	getAttributeType() Returns the attribute type of the clustering attribute.
String	getHierarchyDelimiter() Returns the hierarchy delimiter.
Boolean	getIsHierarchy() Is the attribute value a list of hierarchy?
Boolean	getIsTokenized() Should the attribute value be tokenized?
String	getTokenizationDelimiter() Returns the tokenization delimiter.
Boolean	isIsHierarchy()
Boolean	isIsTokenized()
void	setAttributeName(String attributeName) Sets the name of the clustering attribute.
void	setAttributeType(String attributeType) Sets the attribute type of the clustering attribute.
void	setHierarchyDelimiter(String hierarchyDelimiter) Sets the hierarchy delimiter.
void	setIsHierarchy(Boolean isHierarchy) Controls whether the attribute value is a list of hierarchy.
void	setIsTokenized(Boolean isTokenized) Should the attribute value be tokenized?
void	setTokenizationDelimiter(String tokenizationDelimiter) Sets the tokenization delimiter.
String	toString() Returns the cluster attribute information.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClusterAttribute

public ClusterAttribute()

ClusterAttribute

public ClusterAttribute(String attributeName,
                        String attributeType,
                        String tokenizationDelimiter,
                        String hierarchyDelimiter,
                        Boolean isTokenized,
                        Boolean isHierarchy)

Creates a ClusterAttribute.

Parameters:

attributeName - name of the cluster attribute

attributeType - type of the cluster attribute

tokenizationDelimiter - tokenization delimiter

hierarchyDelimiter - hierarchy delimiter

isTokenized - should the attribute value be tokenized?

isHierarchy - is the attribute value hierarchical?

Method Detail

getAttributeName

public String getAttributeName()

Returns the attribute name used for clustering.

setAttributeName

public void setAttributeName(String attributeName)

Sets the name of the clustering attribute.

Parameters:

attributeName - the attribute name

getAttributeType

public String getAttributeType()

Returns the attribute type of the clustering attribute. Possible values are 'STRING', 'DATE', and 'NUMBER'.

setAttributeType

public void setAttributeType(String attributeType)

Sets the attribute type of the clustering attribute. Possible values are 'STRING', 'DATE', and 'NUMBER'.

Parameters:

attributeName - the attribute name

getTokenizationDelimiter

public String getTokenizationDelimiter()

Returns the tokenization delimiter.

setTokenizationDelimiter

public void setTokenizationDelimiter(String tokenizationDelimiter)

Sets the tokenization delimiter.

Parameters:

tokenizationDelimiter - the tokenization delimiter

getHierarchyDelimiter

public String getHierarchyDelimiter()

Returns the hierarchy delimiter.

setHierarchyDelimiter

public void setHierarchyDelimiter(String hierarchyDelimiter)

Sets the hierarchy delimiter.

Parameters:

hierarchyDelimiter - the hierarchy delimiter

getIsTokenized

public Boolean getIsTokenized()

Should the attribute value be tokenized? Applicable only to the String attribute type.

isIsTokenized

public Boolean isIsTokenized()

setIsTokenized

public void setIsTokenized(Boolean isTokenized)

Should the attribute value be tokenized?

Parameters:

isTokenize - the tokenization flag

getIsHierarchy

public Boolean getIsHierarchy()

Is the attribute value a list of hierarchy?

isIsHierarchy

public Boolean isIsHierarchy()

setIsHierarchy

public void setIsHierarchy(Boolean isHierarchy)

Controls whether the attribute value is a list of hierarchy.

Parameters:

isHierarchy - - a value of true or false for the hierarchy flag

toString

public String toString()

Returns the cluster attribute information.

Overrides:

toString in class Object

Returns:

attribute configuration

Skip navigation links