Skip navigation links

oracle.search.query.webservice.client
Class ClusterConfig

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

All Implemented Interfaces:

Serializable

public class ClusterConfig

extends Object

implements Serializable

ClusterConfig represents the configuration settings of a cluster.

See Also:

Serialized Form

Constructor Summary

ClusterConfig()

ClusterConfig(String clusterName, String clusterType, String clusterFormat)
Creates a ClusterConfig.

Method Summary

ClusterAttribute[]	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.
Property[]	getConfigProperties() Returns the config properties used for clustering.
String	getConfigValue(String paramName) Returns the configuration value of the specified parameter.
void	setClusterAttributes(ClusterAttribute[] clusterAttributes) Set the attribute list used for clustering
void	setClusterFormat(String clusterFormat) Set the format of the cluster.
void	setClusterName(String clusterName) Sets the name of the cluster.
void	setClusterType(String clusterType) Sets the type of the cluster.
void	setConfigProperties(Property[] configProperties) Sets the configuration properties used for clustering.
void	setConfigValue(String paramName, String paramValue) Sets the configuration value of the specified parameter.
String	toString() Returns the values of the configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterConfig

public ClusterConfig()

ClusterConfig

public ClusterConfig(String clusterName,
                     String clusterType,
                     String clusterFormat)

Creates a ClusterConfig.

Parameters:

clusterName - name of the cluster attribute

clusterType - type of the cluster attribute

clusterFormat - cluster output format

Method Detail

getClusterName

public String getClusterName()

Returns the name of the cluster.

setClusterName

public void setClusterName(String clusterName)

Sets the name of the cluster.

Parameters:

clusterName - the name of the cluster tree

getClusterType

public String getClusterType()

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

setClusterType

public void setClusterType(String clusterType)

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

Parameters:

clusterType - the type of the cluster tree

getClusterFormat

public String getClusterFormat()

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

setClusterFormat

public void setClusterFormat(String clusterFormat)

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

Parameters:

clusterFormat - the output format of the cluster tree

getClusterAttributes

public ClusterAttribute[] getClusterAttributes()

Return the attribute list used for clustering

setClusterAttributes

public void setClusterAttributes(ClusterAttribute[] clusterAttributes)

Set the attribute list used for clustering

Parameters:

clusterAttributes - the array of the cluster attributes

getConfigProperties

public Property[] getConfigProperties()

Returns the config properties used for clustering.

setConfigProperties

public void setConfigProperties(Property[] configProperties)

Sets the configuration properties used for clustering.

getConfigValue

public String getConfigValue(String paramName)

Returns the configuration value of the specified parameter. Returns null if the parameter does not exist.

Parameters:

maxTreeDepth - - maximum level of cluster node hierarchy.

minDocumentsPerNode - - minimum number of documents within one node.

maxChildrenPerNode - - maximum number of nodes on each level. The following parameters are only applicable to topic clustering

maxPhraseLength - - maximum number of words for each phrase to extract.

maxNumPhraseToExtract - - maximum number of multi-word phrase to extract.

maxNumSingleWordToExtract - - maximum number of one-word phrase to extract.

minSingleWordOccurrence - - minimum one-word phrase frequency to extract.

minPhraseOccurrence - - minimum multi-word phrase frequency to extract.

paramName - the configuration parameter name

setConfigValue

public void setConfigValue(String paramName,
                           String paramValue)

Sets the configuration value of the specified parameter. The value is ignored if the parameter does not exist. Valid parameter name are:

Parameters:

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

paramName - the configuration parameter name

paramValue - the configuration parameter value

toString

public String toString()

Returns the values of the configuration.

Overrides:

toString in class Object

Skip navigation links