Skip navigation links

oracle.search.query.webservice.wssclient
Class ClusterConfig

java.lang.Object
oracle.search.query.webservice.wssclient.ClusterConfig

public class ClusterConfig

extends Object

ClusterConfig represents the configuration settings of a cluster.

Constructor Summary

ClusterConfig()

Method Summary

List	getClusterAttributes() Return the attribute list used for clustering.
String	getClusterFormat() Returns the format of the cluster.
String	getClusterName() Returns the name of the cluster.
String	getClusterType() Returns the type of the cluster.
List	getConfigProperties() Returns the config properties used for clustering.
void	setClusterFormat(String value) Sets the format of the cluster.
void	setClusterName(String value) Sets the name of the cluster.
void	setClusterType(String value) Sets the type of the cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterConfig

public ClusterConfig()

Method Detail

getClusterAttributes

public List getClusterAttributes()

Return the attribute list used for clustering.

Returns:

a list of ClusterAttribute

getClusterFormat

public String getClusterFormat()

Returns the format of the cluster. The value can be "json" or "xml"

Returns:

cluster format

setClusterFormat

public void setClusterFormat(String value)

Sets the format of the cluster.

Parameters:

value - "json" or "xml"

getClusterName

public String getClusterName()

Returns the name of the cluster.

Returns:

the name of the cluster.

setClusterName

public void setClusterName(String value)

Sets the name of the cluster.

Parameters:

value - name of the cluster

getClusterType

public String getClusterType()

Returns the type of the cluster. Possible values are 'topic' and 'metadata'.

Returns:

'topic' or 'metadata'

setClusterType

public void setClusterType(String value)

Sets the type of the cluster. Possible values are 'topic' and 'metadata'.

Parameters:

value - 'topic' or 'metadata'

getConfigProperties

public List getConfigProperties()

Returns the config properties used for clustering.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the configProperties property.

For example, to add a new item, do as follows:

    getConfigProperties().add(newItem);
 

Supported properties are: maxTreeDepth - - maximum level of cluster node hierarchy. Default is 4 minDocumentsPerNode - - minimum number of documents within one node. Default is 3 maxChildrenPerNode - - maximum number of nodes on each level. Default is 50 The following parameters are only applicable to topic clustering maxPhraseLength - - maximum number of words for each phrase to extract. Default is 6 maxNumPhraseToExtract - - maximum number of multi-word phrase to extract. Default is 5 maxNumSingleWordToExtract - - maximum number of one-word phrase to extract. Default is 10 minSingleWordOccurrence - - minimum one-word phrase frequency to extract. Default is 3 minPhraseOccurrence - - minimum multi-word phrase frequency to extract. Default is 2

Returns:

a list of Property

Skip navigation links