org.apache.jackrabbit.webdav.search
Class QueryGrammerSet

java.lang.Object
  extended by org.apache.jackrabbit.webdav.property.AbstractDavProperty<Set<? extends XmlSerializable>>
      extended by org.apache.jackrabbit.webdav.search.QueryGrammerSet
All Implemented Interfaces:
DavConstants, DavProperty<Set<? extends XmlSerializable>>, PropEntry, SearchConstants, XmlSerializable

public class QueryGrammerSet
extends AbstractDavProperty<Set<? extends XmlSerializable>>
implements SearchConstants

QueryGrammerSet is a DavProperty that encapsulates the 'supported-query-grammer-set' as defined by the Webdav SEARCH internet draft.


Field Summary
 
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
 
Fields inherited from interface org.apache.jackrabbit.webdav.DavConstants
creationDateFormat, DEPTH_0, DEPTH_1, DEPTH_INFINITY, DEPTH_INFINITY_S, HEADER_AUTHORIZATION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_DAV, HEADER_DEPTH, HEADER_DESTINATION, HEADER_ETAG, HEADER_IF, HEADER_LAST_MODIFIED, HEADER_LOCK_TOKEN, HEADER_OVERWRITE, HEADER_TIMEOUT, INFINITE_TIMEOUT, modificationDateFormat, NAMESPACE, OPAQUE_LOCK_TOKEN_PREFIX, PROPERTY_CREATIONDATE, PROPERTY_DISPLAYNAME, PROPERTY_GETCONTENTLANGUAGE, PROPERTY_GETCONTENTLENGTH, PROPERTY_GETCONTENTTYPE, PROPERTY_GETETAG, PROPERTY_GETLASTMODIFIED, PROPERTY_LOCKDISCOVERY, PROPERTY_RESOURCETYPE, PROPERTY_SOURCE, PROPERTY_SUPPORTEDLOCK, PROPFIND_ALL_PROP, PROPFIND_ALL_PROP_INCLUDE, PROPFIND_BY_PROPERTY, PROPFIND_PROPERTY_NAMES, TIMEOUT_INFINITE, UNDEFINED_TIME, UNDEFINED_TIMEOUT, XML_ACTIVELOCK, XML_ALLPROP, XML_COLLECTION, XML_DEPTH, XML_DST, XML_EXCLUSIVE, XML_HREF, XML_INCLUDE, XML_KEEPALIVE, XML_LINK, XML_LOCKENTRY, XML_LOCKINFO, XML_LOCKROOT, XML_LOCKSCOPE, XML_LOCKTOKEN, XML_LOCKTYPE, XML_MULTISTATUS, XML_OMIT, XML_OWNER, XML_PROP, XML_PROPERTYBEHAVIOR, XML_PROPERTYUPDATE, XML_PROPFIND, XML_PROPNAME, XML_PROPSTAT, XML_REMOVE, XML_RESPONSE, XML_RESPONSEDESCRIPTION, XML_SET, XML_SHARED, XML_SOURCE, XML_STATUS, XML_TIMEOUT, XML_WRITE
 
Constructor Summary
QueryGrammerSet()
          Create a new empty QueryGrammerSet.
 
Method Summary
 void addQueryLanguage(String grammerName, Namespace namespace)
          Add another query queryGrammer to this set.
 String[] getQueryLanguages()
          Return a String array containing the URIs of the query languages supported.
 Set<? extends XmlSerializable> getValue()
          Returns the set of supported query grammers.
 Element toXml(Document document)
          Return the Xml representation of this property according to the definition of the 'supported-query-grammer-set'.
 
Methods inherited from class org.apache.jackrabbit.webdav.property.AbstractDavProperty
equals, getName, hashCode, isInvisibleInAllprop
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueryGrammerSet

public QueryGrammerSet()
Create a new empty QueryGrammerSet. Supported query grammers may be added by calling addQueryLanguage(String, Namespace).

Method Detail

addQueryLanguage

public void addQueryLanguage(String grammerName,
                             Namespace namespace)
Add another query queryGrammer to this set.

Parameters:
grammerName -
namespace -

getQueryLanguages

public String[] getQueryLanguages()
Return a String array containing the URIs of the query languages supported.

Returns:
names of the supported query languages

toXml

public Element toXml(Document document)
Return the Xml representation of this property according to the definition of the 'supported-query-grammer-set'.

Specified by:
toXml in interface XmlSerializable
Overrides:
toXml in class AbstractDavProperty<Set<? extends XmlSerializable>>
Parameters:
document -
Returns:
Xml representation
See Also:
SearchConstants.QUERY_GRAMMER_SET, XmlSerializable.toXml(Document)

getValue

public Set<? extends XmlSerializable> getValue()
Returns the set of supported query grammers.

Specified by:
getValue in interface DavProperty<Set<? extends XmlSerializable>>
Returns:
list of supported query languages.
See Also:
DavProperty.getValue()


Copyright © 2004-2010 The Apache Software Foundation. All Rights Reserved.