com.sssw.cm.api
Interface EbiOperatorDescriptor

All Superinterfaces:

Comparable

public interface EbiOperatorDescriptor

extends Comparable

Objects that implement this interface represent operators that are valid when executing Document Metadata queries.

An operator is characterized by the following:

• Name - the operator name, e.g. EboDocQueryOpUtil.ROP_EQUAL;
• Display name - the displayable operator name, e.g. "is equal to";
• Type - the operator type, e.g. EboDocQueryOpUtil.OP_TYPE_REL;
• Type description - the displayable operator type, e.g. "string", "relational", etc.;
• Kind - the operator kind, e.g. EboDocQueryOpUtil.OP_KIND_BINARY;
• Index - the operator index in the operator list, e.g. EboDocQueryOpUtil.IDX_ROP_EQUAL.

See Also:

EboDocQueryOpUtil

Method Summary

String	getKindDescription() Gets the user-friendly, displayable operator kind description such as "binary", "unary", etc.
String	getOperatorDisplayName() Gets the display (user-friendly) name of the operator
int	getOperatorIndex() Gets the index of the operator
int	getOperatorKind() Gets the kind of the operator (binary, unary, etc.)
String	getOperatorName() Gets the name of the operator
int	getOperatorType() Get the type of the operator (string, relational, etc.) See also: EboDocQueryOpUtil.OP_TYPE_STR, OP_TYPE_REL, OP_TYPE_OTHER
String	getTypeDescription() Get the user-friendly, displayable operator type description such as "string", "relational", etc.

Methods implemented from interface java.lang.Comparable

compareTo

Method Detail

getOperatorName

public String getOperatorName()

Gets the name of the operator

Returns:

the name of the operator

getOperatorDisplayName

public String getOperatorDisplayName()

Gets the display (user-friendly) name of the operator

Returns:

the display name of the operator

getOperatorIndex

public int getOperatorIndex()

Gets the index of the operator

Returns:

the index of the operator

getOperatorType

public int getOperatorType()

Get the type of the operator (string, relational, etc.) See also: EboDocQueryOpUtil.OP_TYPE_STR, OP_TYPE_REL, OP_TYPE_OTHER

Returns:

the type of the operator

getOperatorKind

public int getOperatorKind()

Gets the kind of the operator (binary, unary, etc.)

Returns:

the kind of the operator

See Also:

"EboDocQueryOpUtil.OP_KIND_*"

getTypeDescription

public String getTypeDescription()

Get the user-friendly, displayable operator type description such as "string", "relational", etc.

Returns:

the type description

getKindDescription

public String getKindDescription()

Gets the user-friendly, displayable operator kind description such as "binary", "unary", etc.

Returns:

the displayable operator kind description