|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bea.content.expression.Search
This represents parameters for searching for Nodes.
There are reserved system properties (not type defined) that may be part of a search. They are:
Field Summary | |
protected Map |
contextParams
The context params. |
protected Expression |
expression
The search expression. |
protected int |
maxReturn
The maximum number of objects to return. |
protected List |
searchPaths
The paths under which to search. |
protected SortCriteria[] |
sortCriteria
The sorting criteria. |
Constructor Summary | |
Search()
Empty constructor. |
|
Search(Expression expr)
Constructor. |
|
Search(int maxReturn,
Expression expr)
Constructor. |
|
Search(int maxReturn,
SortCriteria[] sortCriteria,
Expression expr)
Constructor. |
|
Search(int maxReturn,
SortCriteria[] sortCriteria,
String expr)
Constructor. |
|
Search(int maxReturn,
String expr)
Constructor. |
|
Search(int maxReturn,
String sort,
Expression expr)
Constructor. |
|
Search(int maxReturn,
String sort,
String expr)
Constructor. |
|
Search(String expr)
Constructor. |
|
Search(String searchPath,
int maxReturn,
SortCriteria[] sortCriteria,
Expression expr)
Constructor. |
|
Search(String searchPath,
int maxReturn,
SortCriteria[] sortCriteria,
String expr)
Constructor. |
|
Search(String searchPath,
int maxReturn,
String sort,
Expression expr)
Constructor. |
|
Search(String searchPath,
int maxReturn,
String sort,
String expr)
Constructor. |
Method Summary | |
void |
addSearchPath(String path)
Add a search path. |
void |
clearSearchPaths()
Clear the search paths. |
Object |
clone()
Make a copy of this object |
boolean |
equals(Object o)
Determine if another object is equals to this. |
Object |
getContextParam(Object key)
Get the value of a context param. |
Map |
getContextParams()
Get an unmodifiable copy of the context params. |
Expression |
getExpression()
Get the search expression. |
int |
getMaxReturn()
Get the maximum number of objects to return. |
int |
getNumSearchPaths()
Get the number of search paths. |
String[] |
getSearchPaths()
Get the search paths. |
Iterator |
getSearchPathsIterator()
Get an iterator over the search paths. |
SortCriteria[] |
getSortCriteria()
Get the sort criteria. |
int |
hashCode()
Override hashcode to use our parts. |
void |
removeSearchPath(String path)
Remove a search path. |
Object |
setContextParam(Object key,
Object value)
Set the value of a context param. |
void |
setContextParams(Map input)
Set the context params based upon the objects in the input map. |
void |
setExpression(Expression expression)
Set the search expression. |
void |
setMaxReturn(int maxReturn)
Set the maximum number of objects to return. |
void |
setSearchPath(String searchPath)
Set the search path to contain just this one. |
void |
setSearchPaths(String[] paths)
Set the search paths. |
void |
setSortCriteria(SortCriteria[] sortCriteria)
Set the sort criteria. |
void |
setSortCriteria(String sort)
Set the sort criteria. |
String |
toString()
Get a String representation of this. |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected Map contextParams
protected Expression expression
protected int maxReturn
Less than 0 signifies returning all matches.
protected List searchPaths
This should be empty to search under all paths (repositories in a federeated search.) This is an OR'ed list.
In a federated search, this can begin with "/*" (e.g."/*/some/path") to denote a search path under each repository. In non-federated search, this should not be construed to contain any special characters.
protected SortCriteria[] sortCriteria
Constructor Detail |
public Search()
public Search(Expression expr)
public Search(int maxReturn, Expression expr)
public Search(int maxReturn, SortCriteria[] sortCriteria, Expression expr)
public Search(int maxReturn, SortCriteria[] sortCriteria, String expr) throws IllegalArgumentException
public Search(int maxReturn, String expr) throws IllegalArgumentException
public Search(int maxReturn, String sort, Expression expr) throws IllegalArgumentException
public Search(int maxReturn, String sort, String expr) throws IllegalArgumentException
public Search(String expr) throws IllegalArgumentException
public Search(String searchPath, int maxReturn, SortCriteria[] sortCriteria, Expression expr)
public Search(String searchPath, int maxReturn, SortCriteria[] sortCriteria, String expr) throws IllegalArgumentException
public Search(String searchPath, int maxReturn, String sort, Expression expr) throws IllegalArgumentException
public Search(String searchPath, int maxReturn, String sort, String expr) throws IllegalArgumentException
Method Detail |
public void addSearchPath(String path)
See searchPaths
for details about what this can be.
public void clearSearchPaths()
public Object clone()
public boolean equals(Object o)
public Object getContextParam(Object key)
public Map getContextParams()
public Expression getExpression()
public int getMaxReturn()
Use less than 0 to signify returning all matches.
public int getNumSearchPaths()
public String[] getSearchPaths()
See searchPaths
for details about what this can be.
public Iterator getSearchPathsIterator()
See searchPaths
for details about what this can be.
public SortCriteria[] getSortCriteria()
public int hashCode()
public void removeSearchPath(String path)
public Object setContextParam(Object key, Object value)
The key and value must be Serializable.
key
- the context param key.value
- the context param value.
public void setContextParams(Map input)
public void setExpression(Expression expression)
public void setMaxReturn(int maxReturn)
Use less than 0 to signify returning all matches.
public void setSearchPath(String searchPath)
See searchPaths
for details about what this can be.
public void setSearchPaths(String[] paths)
public void setSortCriteria(SortCriteria[] sortCriteria)
public void setSortCriteria(String sort) throws IllegalArgumentException
IllegalArgumentException
- if the str string isn't valid occurred
to SortCriteria.getSortCriteria(java.lang.String)
.public String toString()
|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |