Skip navigation links

oracle.search.query.webservice.client
Class ClusterConfig

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

public class ClusterConfig

extends Object

ClusterConfig represents the configuration settings of a cluster

Constructor Summary

ClusterConfig()

ClusterConfig(String clusterName, String clusterType, String clusterFormat)
Create a ClusterConfig

Method Summary

ClusterAttribute[]	getClusterAttributes() Return the attribute list used for clustering
String	getClusterFormat() Return the format of the cluster.
String	getClusterName() Return the name of the cluster
String	getClusterType() Return the type of the cluster.
Property[]	getConfigProperties() Return the config properties used for clustering
String	getConfigValue(String paramName) Return 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) Set the name of the cluster
void	setClusterType(String clusterType) Set the type of the cluster.
void	setConfigProperties(Property[] configProperties) set the config properties used for clustering
void	setConfigValue(String paramName, String paramValue) Set the configuration value of the specified parameter.
String	toString() Return 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)

Create a ClusterConfig

Parameters:

clusterName - name of the cluster attribute

clusterType - type of the cluster attribute

clusterFormat - cluster output format

Method Detail

getClusterAttributes

public ClusterAttribute[] getClusterAttributes()

Return the attribute list used for clustering

getConfigProperties

public Property[] getConfigProperties()

Return the config properties used for clustering

setConfigProperties

public void setConfigProperties(Property[] configProperties)

set the config properties used for clustering

getClusterName

public String getClusterName()

Return the name of the cluster

getClusterType

public String getClusterType()

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

getClusterFormat

public String getClusterFormat()

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

getConfigValue

public String getConfigValue(String paramName)

Return the configuration value of the specified parameter. Return null if the parameter does not exist. maxTreeDepth - max. level of cluster node hierarchy. minDocumentsPerNode - min. number of documents within one node. maxChildrenPerNode - max. number of nodes on each level. The following parameters are only applicable to topic clustering maxPhraseLength - max. number of words for each phrase to extract. maxNumPhraseToExtract - max. number of multi-word phrase to extract. maxNumSingleWordToExtract - max. number of one-word phrase to extract. minSingleWordOccurrence - min. one-word phrase frequency to extract. minPhraseOccurrence - min. multi-word phrase frequency to extract.

Parameters:

paramName - the configuration parameter name

setClusterAttributes

public void setClusterAttributes(ClusterAttribute[] clusterAttributes)

Set the attribute list used for clustering

Parameters:

clusterAttributes - the array of the cluster attributes

setClusterName

public void setClusterName(String clusterName)

Set the name of the cluster

Parameters:

clusterName - the name of the cluster tree

setClusterType

public void setClusterType(String clusterType)

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

Parameters:

clusterType - the type of the cluster tree

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

setConfigValue

public void setConfigValue(String paramName,
                           String paramValue)

Set the configuration value of the specified parameter. Valus is ignored if the parameter does not exist. Valid parameter name are: maxTreeDepth - max. level of cluster node hierarchy. Default is 4 minDocumentsPerNode - min. number of documents within one node. Default is 3 maxChildrenPerNode - max. number of nodes on each level. Default is 50 The following parameters are only applicable to topic clustering maxPhraseLength - max. number of words for each phrase to extract. Default is 6 maxNumPhraseToExtract - max. number of multi-word phrase to extract. Default is 5 maxNumSingleWordToExtract - max. number of one-word phrase to extract. Default is 10 minSingleWordOccurrence - min. one-word phrase frequency to extract. Default is 3 minPhraseOccurrence - min. multi-word phrase frequency to extract. Default is 2

Parameters:

paramName - the configuration parameter name

paramValue - the configuration parameter value

toString

public String toString()

Return the values of the configuration

Skip navigation links