org.alfresco.cmis
Class PropertyFilter

java.lang.Object
  org.alfresco.cmis.PropertyFilter

public class PropertyFilter
extends java.lang.Object

http://docs.oasis-open.org/cmis/CMIS/v1.0/os/cmis-spec-v1.0.htm 2.1.2.1 Property All properties MUST supply a String queryName attribute which is used for query and filter operations on object-types. This is an opaque String with limitations. This string SHOULD NOT contain any characters that negatively interact with the BNF grammar. The string MUST NOT contain: whitespace “ “, comma “,” double quotes ‘”’ single quotes “’” backslash “\” the period “.” character or, the open “(“ or close “)” parenthesis characters. 2.2.1.2.1 Properties Description: All of the methods that allow for the retrieval of properties for CMIS Objects have a “Property Filter” as an optional parameter, which allows the caller to specify a subset of properties for Objects that MUST be returned by the repository in the output of the method. Optional Input Parameter: String filter: Value indicating which properties for Objects MUST be returned. Values are: - Not set: The set of properties to be returned MUST be determined by the repository. - A comma-delimited list of property definition Query Names: The properties listed MUST be returned. - “*” : All properties MUST be returned for all objects. Repositories SHOULD return only the properties specified in the property filter if they exist on the object’s type definition. If a property filter specifies a property that is ‘not set’, it MUST be represented as a property element without a value element.

Field Summary

static java.lang.String	MATCH_ALL_FILTER
static java.lang.String	PROPERTY_NAME_TOKENS_DELIMITER

Constructor Summary

PropertyFilter(java.lang.String filter)

Method Summary

boolean

allow(java.lang.String property)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MATCH_ALL_FILTER

public static final java.lang.String MATCH_ALL_FILTER

See Also:

Constant Field Values

PROPERTY_NAME_TOKENS_DELIMITER

public static final java.lang.String PROPERTY_NAME_TOKENS_DELIMITER

See Also:

Constant Field Values

Constructor Detail

PropertyFilter

public PropertyFilter(java.lang.String filter)
               throws CMISFilterNotValidException

Parameters:

filter - filter value (case insensitive)

Throws:

CMISFilterNotValidException - if filter string isn't valid

Method Detail

allow

public boolean allow(java.lang.String property)

Parameters:

property - property token name

Returns:

true returns if property is allowed by filter. In other case returns false