Skip navigation links

com.flashline.registry.openapi.query
Class SearchTerm

java.lang.Object
com.flashline.registry.openapi.query.SearchTerm

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DateRangeSearchTerm, OPBTW, OPEQ, OPEQIC, OPGT, OPGTE, OPIN, OPLIKE, OPLT, OPLTE, OPNEQ, OPNOTIN

public class SearchTerm

extends java.lang.Object

implements java.io.Serializable

A basic search term stored as a key/value(s) pair with a specified operator.

See Also:

Serialized Form

Constructor Summary

SearchTerm()

SearchTerm(java.lang.String key, java.lang.String operator, java.lang.String qualifier, java.lang.String value, java.lang.String valueType, java.lang.String[] values)

Method Summary

boolean	equals(java.lang.Object obj)
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Get Custom Deserializer
java.lang.String	getKey() Gets the key or search criteria name.
java.lang.String	getOperator() Get the operator that specifies the relationship between the key and the value.
java.lang.String	getQualifier() Gets the qualifier value for this SearchTerm.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
java.lang.String	getValue() Returns the first value in the list of values if multiple values are set.
java.lang.String[]	getValues() Gets the search criteria values as a string array.
java.lang.String	getValueType() Returns the type of the value in this term.
int	hashCode()
void	setKey(java.lang.String key) Sets the key or search criteria name.
void	setOperator(java.lang.String operator) Set the operator that specifies the relationship between the key and the value.
void	setQualifier(java.lang.String qualifier) Sets the qualifier value for this SearchTerm.
void	setValue(java.lang.String value) Set a single value, but only if the value is not null or blank.
void	setValues(java.lang.String[] values) Sets the search criteria values as a string array.
void	setValueType(java.lang.String valueType) Sets the type of the value in this term.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTerm

public SearchTerm()

SearchTerm

public SearchTerm(java.lang.String key,
                  java.lang.String operator,
                  java.lang.String qualifier,
                  java.lang.String value,
                  java.lang.String valueType,
                  java.lang.String[] values)

Method Detail

getKey

public java.lang.String getKey()

Gets the key or search criteria name.

Returns:

Returns the key.

setKey

public void setKey(java.lang.String key)

Sets the key or search criteria name.

Parameters:

pKey - the key

getOperator

public java.lang.String getOperator()

Get the operator that specifies the relationship between the key and the value. One of: EQ, LIKE, NEQ, LT, LTE, GT, GTE, IN, NOTIN

Returns:

the operator.

setOperator

public void setOperator(java.lang.String operator)

Set the operator that specifies the relationship between the key and the value. One of: EQ, LIKE, NEQ, LT, LTE, GT, GTE, IN, NOTIN

getQualifier

public java.lang.String getQualifier()

Gets the qualifier value for this SearchTerm.

Returns:

qualifier

setQualifier

public void setQualifier(java.lang.String qualifier)

Sets the qualifier value for this SearchTerm.

Parameters:

qualifier -

getValue

public java.lang.String getValue()

Returns the first value in the list of values if multiple values are set.

Returns:

the value

setValue

public void setValue(java.lang.String value)

Set a single value, but only if the value is not null or blank. This is to handle deserialization when multiple values have been set, but an explicit single value has NOT been set.

Parameters:

pValue - the single value to set

getValueType

public java.lang.String getValueType()

Returns the type of the value in this term. This is relevant to how some operators work (e.g., LT, GT, etc.). Default is "alpha".

Returns:

type of the value(s) in this term.

setValueType

public void setValueType(java.lang.String valueType)

Sets the type of the value in this term. This is relevant to how some operators work (e.g., LT, GT, etc.). Default is "string". Valid values are "alpha", "number", and "date".

getValues

public java.lang.String[] getValues()

Gets the search criteria values as a string array.

Returns:

Returns the values.

setValues

public void setValues(java.lang.String[] values)

Sets the search criteria values as a string array.

Parameters:

pValues - the values.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Get Custom Deserializer

Skip navigation links