Skip navigation links

oracle.imaging
Class Search.Condition

java.lang.Object
oracle.imaging.Search.Node
oracle.imaging.Search.Condition

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Search

public static class Search.Condition

extends Search.Node

The Condition class defines a leaf of a Search$Node. This class defines the following objects:

• valid search operators ( Search$Operator) for a SearchCondition object.
• Search Properties Search$Condition$PropertyThe valid properties the condition clause may use to search on.

It allows the use of either field definition from an application or the use of predefined properties Search.Condition.Property. The Search condition combines the field definition or property with a condition searchOperator and a search value. If a parametername is specified, then the condition's search value may be updated dynamically from a map of parameter values.

This object is a leaf object and therefore is a terminal point in the search expression.

See Also:

Serialized Form

Nested Class Summary

static class

Search.Condition.Property This is an enumeration of the valid Imaging Attributes that may be used in a search.

Nested classes/interfaces inherited from class oracle.imaging.Search.Node

Search.Node.NodePk

Field Summary

Fields inherited from class oracle.imaging.Search.Node

leftId, leftOperand, rightId, rightOperand, search, searchNodeId, searchOperator

Constructor Summary

Search.Condition()
Default constructor required for JAXB serialization.

Search.Condition(NameId fieldDefinition, Search.Operator operator, SearchValue searchValue)
Convienence Constructor.

Search.Condition(NameId fieldDefinition, Search.Operator operator, java.lang.String parameterName)
Convienence Constructor.

Search.Condition(Search.Condition condition)
Convienence Constructor.

Method Summary

NameId	getFieldDefinition() Gets the field identifier (NameId) this condition will search for.
Search.Node	getLeftOperand() This method is overridden to return null because the the SearchCondition class is a leaf in the tree structure.
java.lang.String	getParameterName() Gets the name of the parameter.
Search.Condition.Property	getProperty() Gets the Search.Condition.Property that the condition will search for.
Search.Node	getRightOperand() This method is overridden to return null because the the SearchCondition class is a leaf in the tree structure.
SearchValue	getSearchValue() Gets the SearchValue that the condition is to use in the search.
boolean	isField() Flag to determine if the condition is a field style condition.
boolean	isLeaf() Flag to determine if the object is a leaf or a node.
boolean	isProperty() Flag to determine if the condition is a property style condition.
boolean	isValidOperator() Determines if the Search$Operator is contained in the list of valid operators for the SearchCondition class.
void	setFieldDefinition(NameId aFieldId) Sets the field identifier (NameId) this condition will search for.
void	setParameterName(java.lang.String newparameterName) Sets the name of the parameter.
void	setProperty(Search.Condition.Property aProperty) Sets the Search.Condition.Property this condition will search for.
void	setSearchValue(SearchValue aSearchValue) Sets the SearchValue to use for this condition.

Methods inherited from class oracle.imaging.Search.Node

getAlwaysDisplayParentheses, getSearchOperator, setAlwaysDisplayParentheses, setLeftOperand, setRightOperand, setSearchOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

Search.Condition

public Search.Condition()

Default constructor required for JAXB serialization.

Search.Condition

public Search.Condition(Search.Condition condition)

Convienence Constructor.

Parameters:

condition -

Search.Condition

public Search.Condition(NameId fieldDefinition,
                        Search.Operator operator,
                        java.lang.String parameterName)

Convienence Constructor.

Parameters:

fieldDefinition - The identifier for the field.

operator - The logical search searchOperator

parameterName - The name key to the parameter witihn the parameter map

Search.Condition

public Search.Condition(NameId fieldDefinition,
                        Search.Operator operator,
                        SearchValue searchValue)

Convienence Constructor.

Parameters:

fieldDefinition - The identifier for the field.

operator - The logical search searchOperator

searchValue - The search value used in this search condition.

Method Detail

getFieldDefinition

public NameId getFieldDefinition()

Gets the field identifier (NameId) this condition will search for. This attribute is mutually exclusive with the property attribute. This attribute is used in conjunction with the application atrribute to uniquely identify the field. If the fieldDefinition is null, then an empty (invalid) value is returned.

Returns:

The fieldDefinition identifier

getLeftOperand

public Search.Node getLeftOperand()

This method is overridden to return null because the the SearchCondition class is a leaf in the tree structure. It has no children to return.

Overrides:

getLeftOperand in class Search.Node

Returns:

null

getParameterName

public java.lang.String getParameterName()

Gets the name of the parameter. If this condition's searchValue is controlled via a SearchArgument, then this attribute will not be null.

Returns:

The associatied parameter name for this SearchCondition.

getProperty

public Search.Condition.Property getProperty()

Gets the Search.Condition.Property that the condition will search for.

Returns:

the property attribute to search for.

getRightOperand

public Search.Node getRightOperand()

This method is overridden to return null because the the SearchCondition class is a leaf in the tree structure. It has no children to return.

Overrides:

getRightOperand in class Search.Node

Returns:

null

getSearchValue

public SearchValue getSearchValue()

Gets the SearchValue that the condition is to use in the search.

Returns:

the value that the search condition is to use in the search.

isField

public final boolean isField()

Flag to determine if the condition is a field style condition. May not be overridden by subclasses.

Returns:

true if the fieldDefinition attribute is a valid NameId.

isLeaf

public final boolean isLeaf()

Flag to determine if the object is a leaf or a node. May not be overridden by subclasses.

Overrides:

isLeaf in class Search.Node

Returns:

true - A SearchCondition is a leaf.

isProperty

public final boolean isProperty()

Flag to determine if the condition is a property style condition. May not be overridden by subclasses.

Returns:

true if the property attribute is not null.

isValidOperator

public boolean isValidOperator()

Determines if the Search$Operator is contained in the list of valid operators for the SearchCondition class.

Specified by:

isValidOperator in class Search.Node

Returns:

true if the opeartor is contained within the list of valid operators.

setFieldDefinition

public void setFieldDefinition(NameId aFieldId)

Sets the field identifier (NameId) this condition will search for. This attribute is mutually exclusive with the property attribute. If the identifier is non-null, then the property attribute will be set to null. This attribute is used in conjunction with the application atrribute to uniquely identify the field.

Parameters:

aFieldId - the identifier for the field.

setParameterName

public void setParameterName(java.lang.String newparameterName)

Sets the name of the parameter. If this condition's searchValue is controlled via a SearchArgument, then this attribute will not be null.

Parameters:

newparameterName - the name key to the parameter witihn the parameter map.

setProperty

public void setProperty(Search.Condition.Property aProperty)

Sets the Search.Condition.Property this condition will search for. This attribute is mutually exclusive with the fieldDefinition attribute. If the property is non-null, then the fieldDefinition attribute will be set to null.

Parameters:

aProperty - the property this condition will test against.

setSearchValue

public void setSearchValue(SearchValue aSearchValue)

Sets the SearchValue to use for this condition.

Parameters:

aSearchValue - The search value used in this search condition.

Skip navigation links