|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jackrabbit.webdav.search.SearchInfo
public class SearchInfo
SearchInfo
parses the 'searchrequest' element of a SEARCH
request body and performs basic validation. Both query language and the
query itself can be access from the resulting object.
NOTE: The query is expected to be represented by the text contained in the
Xml element specifying the query language, thus the 'basicsearch' defined
by the Webdav Search Internet Draft is not supported by this implementation.
<d:searchrequest xmlns:d="DAV:" dcr:="http://www.day.com/jcr/webdav/1.0" > <dcr:xpath>//sv:node[@sv:name='myapp:paragraph'][1]</dcr:xpath> </d:searchrequest>Would return the following values:
getLanguageName() -> xpath getQuery() -> //sv:node[@sv:name='myapp:paragraph'][1]
Field Summary | |
---|---|
static long |
NRESULTS_UNDEFINED
|
static long |
OFFSET_UNDEFINED
|
Fields inherited from interface org.apache.jackrabbit.webdav.search.SearchConstants |
---|
BASICSEARCH, HEADER_DASL, NAMESPACE, QUERY_GRAMMER_SET, XML_GRAMMER, XML_QUERY_GRAMMAR, XML_QUERY_SCHEMA_DISCOVERY, XML_SEARCHREQUEST |
Constructor Summary | |
---|---|
SearchInfo(String language,
Namespace languageNamespace,
String query)
Create a new SearchInfo instance. |
|
SearchInfo(String language,
Namespace languageNamespace,
String query,
Map namespaces)
Create a new SearchInfo instance. |
Method Summary | |
---|---|
static SearchInfo |
createFromXml(Element searchRequest)
Create a new SearchInfo from the specifying document
retrieved from the request body. |
String |
getLanguageName()
Returns the name of the query language to be used. |
Namespace |
getLanguageNameSpace()
Returns the namespace of the language specified with the search request element. |
Map |
getNamespaces()
Returns the namespaces that have been re-mapped by the user. |
long |
getNumberResults()
Returns the maximal number of search results that should be returned. |
long |
getOffset()
Returns the desired offset in the total result set. |
String |
getQuery()
Return the query string. |
void |
setNumberResults(long nresults)
Sets the maximal number of search results that should be returned. |
void |
setOffset(long offset)
Sets the desired offset in the total result set. |
Element |
toXml(Document document)
Return the xml representation of this SearchInfo instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long NRESULTS_UNDEFINED
public static final long OFFSET_UNDEFINED
Constructor Detail |
---|
public SearchInfo(String language, Namespace languageNamespace, String query, Map namespaces)
SearchInfo
instance.
language
- languageNamespace
- query
- namespaces
- the re-mapped namespaces. Key=prefix, value=uri.public SearchInfo(String language, Namespace languageNamespace, String query)
SearchInfo
instance.
language
- languageNamespace
- query
- Method Detail |
---|
public String getLanguageName()
public Namespace getLanguageNameSpace()
public String getQuery()
public Map getNamespaces()
public long getNumberResults()
public void setNumberResults(long nresults)
nresults
- The maximal number of search resultspublic long getOffset()
public void setOffset(long offset)
offset
- The desired offset in the total result set.public Element toXml(Document document)
SearchInfo
instance.
toXml
in interface XmlSerializable
document
-
public static SearchInfo createFromXml(Element searchRequest) throws DavException
SearchInfo
from the specifying document
retrieved from the request body.
searchRequest
-
DavException
- if the root element's name is other than
'searchrequest' or if it does not contain a single child element specifying
the query language to be used.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |