Skip navigation links

oracle.search.query.webservice.client
Class ClusterAttribute

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

public class ClusterAttribute

extends Object

ClusterAttribute represents the grouping settings of a document attribute

Constructor Summary

ClusterAttribute()

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

Method Summary

String	getAttributeName() Return the attribute name used for clustering
String	getAttributeType() Return the attribute type of the clustering attribute.
String	getHierarchyDelimiter() Return the hierarchy delimiter
Boolean	getIsHierarchy() Is the attribute value is a list of hierarchy?
Boolean	getIsTokenized() Should the attribute value be tokenized?
String	getTokenizationDelimiter() Return the tokenization delimiter
void	setAttributeName(String attributeName) Set the name of the clustering atrtribute
void	setAttributeType(String attributeName) Set the attribute type of the clustering attribute.
void	setHierarchyDelimiter(String hierarchyDelimiter) Set the hierarchy delimiter
void	setIsHierarchy(Boolean isHierarchy) Set whether the attribute value is a list of hierarchy?
void	setIsTokenized(Boolean isTokenize) Should the attribute value be tokenized?
void	setTokenizationDelimiter(String tokenizationDelimiter) Set the tokenization delimiter
String	toString() Return 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)

Create 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()

Return the attribute name used for clustering

getAttributeType

public String getAttributeType()

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

getTokenizationDelimiter

public String getTokenizationDelimiter()

Return the tokenization delimiter

getHierarchyDelimiter

public String getHierarchyDelimiter()

Return the hierarchy delimiter

getIsTokenized

public Boolean getIsTokenized()

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

getIsHierarchy

public Boolean getIsHierarchy()

Is the attribute value is a list of hierarchy?

setAttributeName

public void setAttributeName(String attributeName)

Set the name of the clustering atrtribute

Parameters:

attributeName - the attribute name

setAttributeType

public void setAttributeType(String attributeName)

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

Parameters:

attributeName - the attribute name

setTokenizationDelimiter

public void setTokenizationDelimiter(String tokenizationDelimiter)

Set the tokenization delimiter

Parameters:

tokenizationDelimiter - the tokenization delimiter

setHierarchyDelimiter

public void setHierarchyDelimiter(String hierarchyDelimiter)

Set the hierarchy delimiter

Parameters:

hierarchyDelimiter - the hierarchy delimiter

setIsTokenized

public void setIsTokenized(Boolean isTokenize)

Should the attribute value be tokenized?

Parameters:

isTokenize - the tokenization flag

setIsHierarchy

public void setIsHierarchy(Boolean isHierarchy)

Set whether the attribute value is a list of hierarchy?

Parameters:

isHierarchy - the hierarchy flag

toString

public String toString()

Return the cluster attribute information

Returns:

attribute configuration

Skip navigation links