gov.nih.nlm.nls.tc.FilterApi
Class OutputFilterOption

java.lang.Object
  gov.nih.nlm.nls.tc.FilterApi.OutputFilterOption

public class OutputFilterOption
extends java.lang.Object

This class is the option object for output filter. It includes:

• the number of output result to display
• a boolean flag to use no Output message (default: true)
• message string for no output
• a boolean flag to display results in cluster
• cluster number
• the increment of cluster
• a Vector to specify JD/ST candidates
• show type for the result: WC, DC, both
• type for the overall result pick
• the decimals to round off
• output fields filter

History:

Version:

V-2011

Author:

NLM Lexical Systems Group

Field Summary

static int	AUTO_SCORE_MULTIPLY_FACTOR
static int	RESULT_TYPE_BOTH
static int	RESULT_TYPE_DC
static int	RESULT_TYPE_WC

Constructor Summary

OutputFilterOption()
Initiate the OutputFilterOption object.

OutputFilterOption(int outputNum, boolean useNoOutputMsg, java.lang.String noOutputMsg, boolean useCluster, float clusterInc, int clusterNum, java.util.Vector<java.lang.String> candidates, int resultType, int showResult, int roundOffDecimals, int scoreMultiplyFactor, java.util.Vector<java.lang.Integer> outputFieldList)
Initiate the PreProcessOption object by specifying all options.

Method Summary

java.util.Vector<java.lang.String>	GetCandidates() Get the Vector to specify candidates, JD/ST.
float	GetClusterInc() Get the increment of cluster.
int	GetClusterNum() Get the number of cluster.
java.lang.String	GetNoOutputMsg() Get the message string for no output.
java.util.Vector<java.lang.Integer>	GetOutputFieldList() Get the output fields list to display
int	GetOutputNum() Get the number of output result to display
int	GetResultType() Get the result type for the overall result pick
int	GetRoundOffDecimals() Get the decimals to round off.
int	GetScoreMultiplyFactor() Get the score multiple factor
int	GetShowResult() Get the type of shown result score
boolean	GetUseCluster() Get the booealn flag to display results in cluster.
boolean	GetUseNoOutputMsg() Get the boolean flag to show no output message.
void	SetCandidates(java.util.Vector<java.lang.String> candidates) Set the candidate for display
void	SetClusterInc(float clusterInc) Set the value of the increment of cluster
void	SetClusterNum(int clusterNum) Set the value of the number of cluster
void	SetNoOutputMsg(java.lang.String noOutputMsg) Set the message for no output.
void	SetOutputFieldList(java.util.Vector<java.lang.Integer> outputFieldList) Set the output fields list
void	SetOutputNum(int outputNum) Set the number of output result to display.
void	SetResultType(int resultType) Set the value of type for the overall result pick.
void	SetRoundOffDecimals(int roundOffDecimals) Set the decimals to round off
void	SetScoreMultiplyFactor(int scoreMultiplyFactor) Set the value of score multiply factor.
void	SetShowResult(int showResult) Set the value of type for the shown result.
void	SetUseCluster(boolean useCluster) Set the boolean flag to display results in cluster.
void	SetUseNoOutputMsg(boolean useNoOutputMsg) Set the boolean flag to show no output message.
java.lang.String	ToString(JournalDescriptors jds) Get a String of showing all output filter option.
java.lang.String	ToString(SemanticTypes sts) Get a String of showing all output filter option.

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_TYPE_WC

public static final int RESULT_TYPE_WC

See Also:

Constant Field Values

RESULT_TYPE_DC

public static final int RESULT_TYPE_DC

See Also:

Constant Field Values

RESULT_TYPE_BOTH

public static final int RESULT_TYPE_BOTH

See Also:

Constant Field Values

AUTO_SCORE_MULTIPLY_FACTOR

public static final int AUTO_SCORE_MULTIPLY_FACTOR

See Also:

Constant Field Values

Constructor Detail

OutputFilterOption

public OutputFilterOption()

Initiate the OutputFilterOption object.

OutputFilterOption

public OutputFilterOption(int outputNum,
                          boolean useNoOutputMsg,
                          java.lang.String noOutputMsg,
                          boolean useCluster,
                          float clusterInc,
                          int clusterNum,
                          java.util.Vector<java.lang.String> candidates,
                          int resultType,
                          int showResult,
                          int roundOffDecimals,
                          int scoreMultiplyFactor,
                          java.util.Vector<java.lang.Integer> outputFieldList)

Initiate the PreProcessOption object by specifying all options.

Parameters:

outputNum - the number of output result to display

useNoOutputMsg - a boolean flag to show no output message

noOutputMsg - message string for no output

useCluster - a booealn flag to display results in cluster

clusterInc - the increment of cluster

clusterNum - the number of cluster

candidates - a Vector to specify candidates, JD/ST

resultType - type for the overall result pick, TYPE_WC for word count and TYPE_DC for document count

showResult - type for result, TYPE_WC for word count, TYPE_DC for document count, TYPE_BOTH for both

roundOffDecimals - the decimals to round off

scoreMultiplyFactor - the score multiply factor

outputFieldList - a Vector to specify the output fields

Method Detail

SetOutputNum

public void SetOutputNum(int outputNum)

Set the number of output result to display.

Parameters:

outputNum - the number of output result to display

SetScoreMultiplyFactor

public void SetScoreMultiplyFactor(int scoreMultiplyFactor)

Set the value of score multiply factor. The default is 0 (10 to the power of 0 = 1), which does not change the score. If the value is AUTO_SCORE_MULTIPLY_FACTOR (-1), the scores will be auto adjusted with the biggest score between 0.1 and 1.0.

Parameters:

scoreMultiplyFactor - the value of score multiply factor

SetUseNoOutputMsg

public void SetUseNoOutputMsg(boolean useNoOutputMsg)

Set the boolean flag to show no output message.

Parameters:

useNoOutputMsg - a boolean flag to show no output message

SetNoOutputMsg

public void SetNoOutputMsg(java.lang.String noOutputMsg)

Set the message for no output.

Parameters:

noOutputMsg - message string for no output

SetUseCluster

public void SetUseCluster(boolean useCluster)

Set the boolean flag to display results in cluster.

Parameters:

useCluster - a booealn flag to display results in cluster

SetClusterInc

public void SetClusterInc(float clusterInc)

Set the value of the increment of cluster

Parameters:

clusterInc - the increment of cluster

SetClusterNum

public void SetClusterNum(int clusterNum)

Set the value of the number of cluster

Parameters:

clusterNum - the number of cluster

SetCandidates

public void SetCandidates(java.util.Vector<java.lang.String> candidates)

Set the candidate for display

Parameters:

candidates - a Vector to specify candidates, JD/ST

SetResultType

public void SetResultType(int resultType)

Set the value of type for the overall result pick.

Parameters:

resultType - type for the overall result pick, TYPE_WC for word count and TYPE_DC for document count

SetShowResult

public void SetShowResult(int showResult)

Set the value of type for the shown result.

Parameters:

showResult - type for the result scores, TYPE_WC for word count, TYPE_DC for document count, and TYPE_BOTH for both

SetRoundOffDecimals

public void SetRoundOffDecimals(int roundOffDecimals)

Set the decimals to round off

Parameters:

roundOffDecimals - the decimals to round off

SetOutputFieldList

public void SetOutputFieldList(java.util.Vector<java.lang.Integer> outputFieldList)

Set the output fields list

Parameters:

outputFieldList - the list of fields to display

GetOutputNum

public int GetOutputNum()

Get the number of output result to display

Returns:

the number of output result to display

GetScoreMultiplyFactor

public int GetScoreMultiplyFactor()

Get the score multiple factor

Returns:

the score multiple factor

GetUseNoOutputMsg

public boolean GetUseNoOutputMsg()

Get the boolean flag to show no output message.

Returns:

boolean flag to show no output message

GetNoOutputMsg

public java.lang.String GetNoOutputMsg()

Get the message string for no output.

Returns:

message string for no output

GetUseCluster

public boolean GetUseCluster()

Get the booealn flag to display results in cluster.

Returns:

booealn flag to display results in cluster

GetClusterInc

public float GetClusterInc()

Get the increment of cluster.

Returns:

the increment of cluster

GetClusterNum

public int GetClusterNum()

Get the number of cluster.

Returns:

the number of cluster

GetCandidates

public java.util.Vector<java.lang.String> GetCandidates()

Get the Vector to specify candidates, JD/ST.

Returns:

a Vector to specify candidates, JD/ST

GetResultType

public int GetResultType()

Get the result type for the overall result pick

Returns:

result type for the overall result pick

GetShowResult

public int GetShowResult()

Get the type of shown result score

Returns:

type of shown result

GetRoundOffDecimals

public int GetRoundOffDecimals()

Get the decimals to round off.

Returns:

the decimals to round off

GetOutputFieldList

public java.util.Vector<java.lang.Integer> GetOutputFieldList()

Get the output fields list to display

Returns:

the list of outptu fields

ToString

public java.lang.String ToString(JournalDescriptors jds)

Get a String of showing all output filter option.

Parameters:

jds - journal descriptors

Returns:

A String of showing all output filter option

ToString

public java.lang.String ToString(SemanticTypes sts)

Get a String of showing all output filter option.

Parameters:

sts - semantic types

Returns:

A String of showing all output filter option