oracle.security.jps.search

Class SearchQuery

java.lang.Object

oracle.security.jps.search.SearchQuery

Direct Known Subclasses:

BaseSearchQuery

public class SearchQuery
extends java.lang.Object

Since:

release specific (what release of product did this appear in)

Version:

$Header: jazn/jps/src/jps-api/oracle/security/jps/search/SearchQuery.java /main/3 2014/08/22 09:45:01 duyang Exp $

Author:

dhgoswam, svepa

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchQuery.MATCHER Rules to match two Strings.

Constructor Summary

Constructors

Constructor and Description
SearchQuery()
SearchQuery(java.util.List<SearchQuery> childQueries, boolean negation, boolean isORMatch) Constructor for a complex query, which consists of some children queries.
SearchQuery(java.lang.String property, boolean negation, SearchComparatorType comparator, java.lang.Object objectValue, SearchQuery.MATCHER matcher) Construct the query object

Method Summary

Methods

Modifier and Type	Method and Description
void	addBaseQuery(SearchQuery query)
SearchQuery[]	getBaseSearchQueryInOrder()
PageRequestInfo	getPageInfo()
java.util.UUID	getPreparedQueryId()
java.lang.String	getSearchByPropertyString()
java.lang.String	getSearchByValue() Get the Search by Value.
<T> T	getSearchByValueObject(java.lang.Class<T> klass) Get the search by value as
SearchComparatorType	getSearchComparator() Returns the search comparator
java.util.ArrayList<SearchQuery>	getSearchQueries() Get the Queries.
SearchQuery.MATCHER	getSearchValueMatch()
boolean	hasPageInfo()
boolean	isANDMatch()
boolean	isComplexQuery() Complex means this query contains some children queries, the query result will be intersection or union of children queries' results See SearchQuery.isANDMatch() and SearchQuery.isORMatch() and SearchQuery.isNegativeMatch() A Complex query may be like: NOT (queryA OR (queryB AND queryC)) Simple query means this query has no children queries, but a simple property assertion.
boolean	isNegativeMatch()
boolean	isORMatch()
void	setPageInfo(PageRequestInfo pageInfo)
void	setPreparedQueryId(java.util.UUID preparedQueryId)
java.lang.String	toString()
void	unsetPageInfo()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchQuery

public SearchQuery()

SearchQuery

public SearchQuery(java.util.List<SearchQuery> childQueries,
           boolean negation,
           boolean isORMatch)

Constructor for a complex query, which consists of some children queries. The MATCHER, ComparatorType is useless for complex query The SearchByProperty, SearchByValue, SearchByValueObject is useless for complex query

Parameters:

childQueries - children queries of this query

negation - if true, then the NOT operator is applied.

isORMatch - if true the syntax among the child queries is 'OR', if false, the syntax among child queries is 'AND'

SearchQuery

public SearchQuery(java.lang.String property,
           boolean negation,
           SearchComparatorType comparator,
           java.lang.Object objectValue,
           SearchQuery.MATCHER matcher)

Construct the query object

Parameters:

property - name of the property

negation - negation value

comparator - comparator

objectValue - the value

matcher - matcher value

Method Detail

getSearchComparator

public SearchComparatorType getSearchComparator()

Returns the search comparator

Returns:

the search comparator

getSearchQueries

public java.util.ArrayList<SearchQuery> getSearchQueries()

Get the Queries.

Returns:

list of queries.

addBaseQuery

public void addBaseQuery(SearchQuery query)

getBaseSearchQueryInOrder

public SearchQuery[] getBaseSearchQueryInOrder()

getSearchByPropertyString

public java.lang.String getSearchByPropertyString()

getSearchByValue

public java.lang.String getSearchByValue()

Get the Search by Value.

Returns:

value

getSearchByValueObject

public <T> T getSearchByValueObject(java.lang.Class<T> klass)

Get the search by value as

Parameters:

klass - the object class

Returns:

the value object

isComplexQuery

public boolean isComplexQuery()

Complex means this query contains some children queries, the query result will be intersection or union of children queries' results See SearchQuery.isANDMatch() and SearchQuery.isORMatch() and SearchQuery.isNegativeMatch() A Complex query may be like: NOT (queryA OR (queryB AND queryC)) Simple query means this query has no children queries, but a simple property assertion. A simple query may be like: NOT (description contains 'weather')

Returns:

true if this is a complex query, false if this is a simple query.

isORMatch

public boolean isORMatch()

Returns:

true if this an OR condition, false otherwise

isANDMatch

public boolean isANDMatch()

Returns:

true if this is an AND condition, false otherwise.

isNegativeMatch

public boolean isNegativeMatch()

Returns:

true if the query should be negated.

getSearchValueMatch

public SearchQuery.MATCHER getSearchValueMatch()

Returns:

the MATCHER to apply to the search value.

getPageInfo

public PageRequestInfo getPageInfo()

setPageInfo

public void setPageInfo(PageRequestInfo pageInfo)

unsetPageInfo

public void unsetPageInfo()

hasPageInfo

public boolean hasPageInfo()

getPreparedQueryId

public java.util.UUID getPreparedQueryId()

setPreparedQueryId

public void setPreparedQueryId(java.util.UUID preparedQueryId)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object