org.apache.jackrabbit.webdav.search

Class SearchInfo

java.lang.Object

org.apache.jackrabbit.webdav.search.SearchInfo

All Implemented Interfaces:

SearchConstants, XmlSerializable

public class SearchInfo
extends Object
implements SearchConstants, XmlSerializable

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.

Example of a valid 'searchrequest' body

 <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

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
SearchInfo(String language, Namespace languageNamespace, String query) Create a new SearchInfo instance.
SearchInfo(String language, Namespace languageNamespace, String query, Map<String,String> namespaces) Create a new SearchInfo instance.

Method Summary

Methods

Modifier and Type	Method and Description
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<String,String>	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

NRESULTS_UNDEFINED

public static final long NRESULTS_UNDEFINED

See Also:

Constant Field Values

OFFSET_UNDEFINED

public static final long OFFSET_UNDEFINED

See Also:

Constant Field Values

Constructor Detail

SearchInfo

public SearchInfo(String language,
          Namespace languageNamespace,
          String query,
          Map<String,String> namespaces)

Create a new SearchInfo instance.

Parameters:

language -

languageNamespace -

query -

namespaces - the re-mapped namespaces. Key=prefix, value=uri.

SearchInfo

public SearchInfo(String language,
          Namespace languageNamespace,
          String query)

Create a new SearchInfo instance.

Parameters:

language -

languageNamespace -

query -

Method Detail

getLanguageName

public String getLanguageName()

Returns the name of the query language to be used.

Returns:

name of the query language

getLanguageNameSpace

public Namespace getLanguageNameSpace()

Returns the namespace of the language specified with the search request element.

Returns:

namespace of the requested language.

getQuery

public String getQuery()

Return the query string.

Returns:

query string

getNamespaces

public Map<String,String> getNamespaces()

Returns the namespaces that have been re-mapped by the user.

Returns:

map of namespace to prefix mappings. Key=prefix, value=uri.

getNumberResults

public long getNumberResults()

Returns the maximal number of search results that should be returned.

Returns:

the maximal number of search results that should be returned.

setNumberResults

public void setNumberResults(long nresults)

Sets the maximal number of search results that should be returned.

Parameters:

nresults - The maximal number of search results

getOffset

public long getOffset()

Returns the desired offset in the total result set.

Returns:

the desired offset in the total result set.

setOffset

public void setOffset(long offset)

Sets the desired offset in the total result set.

Parameters:

offset - The desired offset in the total result set.

toXml

public Element toXml(Document document)

Return the xml representation of this SearchInfo instance.

Specified by:

toXml in interface XmlSerializable

Parameters:

document -

Returns:

xml representation

createFromXml

public static SearchInfo createFromXml(Element searchRequest)
                                throws DavException

Create a new SearchInfo from the specifying document retrieved from the request body.

Parameters:

searchRequest -

Throws:

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.