Skip navigation links

Oracle Secure Enterprise Search Java API Reference
11g Release 2 (11.2.1.0.0)

E17597-02


oracle.search.query.webservice.client
Class Filter

java.lang.Object
  extended by oracle.search.query.webservice.client.Filter

All Implemented Interfaces:
Serializable

public class Filter
extends Object
implements Serializable

Filter encapsulates a filter condition (predicate) for search.

See Also:
Serialized Form

Constructor Summary
Filter()
           
Filter(Integer attributeId, String attributeType, String operator, String attributeValue)
           

 

Method Summary
 Integer getAttributeId()
          Returns the ID of the attribute used in the predicate.
 String getAttributeType()
          Returns the type of the attribute used in the predicate.
 String getAttributeValue()
          Returns the value of the attribute used in the predicate.
 String getOperator()
          Returns the operator of the attribute used in the predicate.
 void setAttributeId(Integer attributeId)
          Sets the ID of the attribute used in the predicate.
 void setAttributeType(String attributeType)
          Sets the type of the attribute used in the predicate.
 void setAttributeValue(String attributeValue)
          Sets the value of the attribute used in the predicate.
 void setOperator(String operator)
          Sets the operator of the attribute used in the predicate.

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

Filter

public Filter()

Filter

public Filter(Integer attributeId,
              String attributeType,
              String operator,
              String attributeValue)
Parameters:
attributeId - ID of the attribute used in the predicate
attributeType - type of the attribute used in the predicate: either "number", "string" or "date"
operator - operator for the filter condition

If the attributeType is "string", then the operator should be either "equals" or "contains". If the attributeType is "number" or "date", then operator should be "greaterthan", "greaterthanequals" , "lessthan", "lessthanequals" or "equals".

attributeValue - value of the attribute used in the predicate

For a "string" type attribute, the value is simply the string itself. For a "number" type attribute, the value should be represented by a string consisting of an optional sign "+" or "-", followed by a sequence of zero or more decimal digits, optionally followed by a fraction. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. For a "date" type attribute, the value should be in the format "mm/dd/yyyy", where mm is the month(00~11), dd is the day(01~31), yyyy is the year.

Method Detail

getAttributeId

public Integer getAttributeId()
Returns the ID of the attribute used in the predicate.

setAttributeId

public void setAttributeId(Integer attributeId)
Sets the ID of the attribute used in the predicate.
Parameters:
attributeId - ID of the attribute used in the predicate

getAttributeType

public String getAttributeType()
Returns the type of the attribute used in the predicate.

setAttributeType

public void setAttributeType(String attributeType)
Sets the type of the attribute used in the predicate.
Parameters:
attributeType - type of the attribute used in the predicate

getOperator

public String getOperator()
Returns the operator of the attribute used in the predicate.

setOperator

public void setOperator(String operator)
Sets the operator of the attribute used in the predicate.
Parameters:
operator - operator for the predicate

getAttributeValue

public String getAttributeValue()
Returns the value of the attribute used in the predicate.

setAttributeValue

public void setAttributeValue(String attributeValue)
Sets the value of the attribute used in the predicate.
Parameters:
attributeValue - value of the attribute used in for the predicate

Skip navigation links

Oracle Secure Enterprise Search Java API Reference
11g Release 2 (11.2.1.0.0)

E17597-02


Copyright © 2006, 2011, Oracle and/or its affiliates. All rights reserved.