oracle.context.isearch.query
Class QueryAttribute

java.lang.Object
  |
  +--oracle.context.isearch.query.QueryAttribute

public class QueryAttribute

extends java.lang.Object

This class encapsulates all information related to a query attribute. Query Attributes are defined by the Ultra Search administrator. Various document attributes such as the author, date and title are mapped to Ultra Search query attributes. In an advanced search, the end-user can specify that the search results contain documents that have specific values for specific query attributes.

Since:

1.0.2

Field Summary

int	id The attribute ID number.
java.lang.String	operator The "AND" or "OR" conditional operator that modifies the query string.
java.lang.String	query The attribute query string.

Constructor Summary

QueryAttribute(int newId, java.lang.String newQuery, java.lang.String newOperator)
Constructor that initializes the Query Attribute ID and query string.

QueryAttribute(java.lang.String newId, java.lang.String newQuery, java.lang.String newOperator)
Overloaded constructor that initializes the Query Attribute ID, query string and operator.

Methods inherited from class java.lang.Object

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

Field Detail

id

public int id

The attribute ID number. Each query attribute has a unique ID number. ID numbers of attributes are loaded from the database.

query

public java.lang.String query

The attribute query string. Query strings for attributes obey the same rules as that for regular query strings. In other words, you can specify that you want to search on a particular attribute and that the attribute value can be either a word, come from a list of words, match an exact phrase, obey a certain wildcard pattern etc.

For more information, please read the documentation on query strings.

operator

public java.lang.String operator

The "AND" or "OR" conditional operator that modifies the query string. For example, a complex query may specify 2 query attributes.
To retrieve documents that match either attribute, you would specify the "OR" string value for each QueryAttribute operator.
To retrieve documents that match both attributes, you would specify the "AND" string value for each QueryAttribute operator.

Constructor Detail

QueryAttribute

public QueryAttribute(int newId,
                      java.lang.String newQuery,
                      java.lang.String newOperator)

Constructor that initializes the Query Attribute ID and query string.

Parameters:

newId - The ID of this attribute.

newQuery - The query string for this attribute.

QueryAttribute

public QueryAttribute(java.lang.String newId,
                      java.lang.String newQuery,
                      java.lang.String newOperator)

Overloaded constructor that initializes the Query Attribute ID, query string and operator.

Parameters:

newId - The ID of this attribute.

newQuery - The query string for this attribute.

newOperator - The conditional boolean operator for this attribute. Must be the "AND" or "OR" string.