Object
Cloneable
, Serializable
This represents parameters for searching for Nodes.
There are reserved system properties (not type defined) that may be part of a search. They are:
Object
Search
Cloneable
, Serializable
Field Summary |
protected |
|
protected |
|
protected int |
|
protected |
|
protected |
|
Constructor Summary |
|
|
|
|
|
|
|
|
|
Method Summary |
public void |
|
public void |
|
public |
|
public boolean | |
public |
|
public |
|
public |
|
public int |
|
public int |
|
public |
|
public |
|
public |
|
public int |
|
public void |
|
public |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public |
|
Methods from class java.lang. |
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,SortCriteria
[] sortCriteria,Expression
expr)
public Search(int maxReturn,SortCriteria
[] sortCriteria,String
expr)
public Search(int maxReturn,
Expression
expr)
public Search(int maxReturn,String
sort,Expression
expr)
public Search(int maxReturn,String
sort,String
expr)
public Search(int maxReturn,
String
expr)
public Search(String
searchPath, int maxReturn,SortCriteria
[] sortCriteria,Expression
expr)
public Search(String
searchPath, int maxReturn,SortCriteria
[] sortCriteria,String
expr)
public Search(String
searchPath, int maxReturn,String
sort,Expression
expr)
public Search(String
searchPath, int maxReturn,String
sort,String
expr)
public Search(String
expr)
Method Detail |
public void addSearchPath(String
path)
Add a search path.
See Search.searchPaths
for details about what this can be.
public void clearSearchPaths()Clear the search paths.
public Object
clone()
Make a copy of this object
Object.clone()
public boolean equals(Object
o)
Determine if another object is equals to this.
Object.equals(Object)
publicGet the value of a context param.Object
getContextParam(Object
key)
public Map
getContextParams()
Get an unmodifiable copy of the context params.
public Expression
getExpression()
Get the search expression.
public int getMaxReturn()Get the maximum number of objects to return.
Use less than 0 to signify returning all matches.
public int getNumSearchPaths()Get the number of search paths.
public String
[] getSearchPaths()
Get the search paths.
See Search.searchPaths
for details about what this can be.
public Iterator
getSearchPathsIterator()
Get an iterator over the search paths.
See Search.searchPaths
for details about what this can be.
public SortCriteria
[] getSortCriteria()
Get the sort criteria.
public int hashCode()Override hashcode to use our parts.
Object.hashCode()
public void removeSearchPath(String
path)
Remove a search path.
publicSet the value of a context param.Object
setContextParam(Object
key,Object
value)
The key and value must be Serializable.
public void setContextParams(Map
input)
Set the context params based upon the objects in the input map.
public void setExpression(Expression
expression)
Set the search expression.
public void setMaxReturn(int maxReturn)Set the maximum number of objects to return.
Use less than 0 to signify returning all matches.
public void setSearchPath(String
searchPath)
Set the search path to contain just this one.
See Search.searchPaths
for details about what this can be.
public void setSearchPaths(String
[] paths)
Set the search paths.
public void setSortCriteria(SortCriteria
[] sortCriteria)
Set the sort criteria.
public void setSortCriteria(Set the sort criteria.String
sort)
throwsIllegalArgumentException
IllegalArgumentException
SortCriteria.getSortCriteria(String)
.
public String
toString()
Get a String representation of this.
Object.toString()