Package org.apache.jackrabbit.spi.commons.nodetype.constraint

Class ValueConstraint

java.lang.Object

org.apache.jackrabbit.spi.commons.nodetype.constraint.ValueConstraint

All Implemented Interfaces:

QValueConstraint

public abstract class ValueConstraint
extends java.lang.Object
implements QValueConstraint

ValueConstraint and its subclasses are used to check the syntax of a value constraint and to test if a specific value satisfies it.

Field Summary

Fields

Modifier and Type	Field	Description
static ValueConstraint[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method	Description
static void	checkValueConstraints(QPropertyDefinition pd, QValue[] values)	Tests if the value constraints defined in the property definition pd are satisfied by the the specified values.
static ValueConstraint	create(int type, java.lang.String definition)	Create a new ValueConstraint from the String representation.
static ValueConstraint[]	create(int type, java.lang.String[] definition)	Create a new ValueConstraint array from the String representation.
static ValueConstraint[]	create(int type, java.lang.String[] jcrDefinition, NamePathResolver resolver)	Create a new ValueConstraint array from the specified JCR representations.
static ValueConstraint	create(int type, java.lang.String jcrDefinition, NamePathResolver resolver)
boolean	equals(java.lang.Object other)
java.lang.String	getDefinition(NamePathResolver resolver)	For constraints that are not namespace prefix mapping sensitive this method returns the same result as getString().
java.lang.String	getString()	For constraints that are not namespace prefix mapping sensitive this method returns the same defined in PropertyDefinition.getValueConstraints().
int	hashCode()	Returns the hashCode of the definition String
java.lang.String	toString()	Same as getString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.jackrabbit.spi.QValueConstraint

check

Field Detail

EMPTY_ARRAY

public static final ValueConstraint[] EMPTY_ARRAY

Method Detail

getDefinition

public java.lang.String getDefinition(NamePathResolver resolver)

For constraints that are not namespace prefix mapping sensitive this method returns the same result as getString().

Those that are namespace prefix mapping sensitive (e.g. NameConstraint, PathConstraint and ReferenceConstraint) use the given nsResolver to reflect the current mapping in the returned value. In other words: subclasses, that need to make a conversion to JCR value must overwrite this and return a value that has the Names or Path properly resolved to their JCR representation.

Parameters:

resolver - name-path resolver

Returns:

the definition of this constraint.

See Also:

(), NameResolver.getJCRName(org.apache.jackrabbit.spi.Name), PathResolver.getJCRPath(org.apache.jackrabbit.spi.Path)

getString

public java.lang.String getString()

Description copied from interface: QValueConstraint

For constraints that are not namespace prefix mapping sensitive this method returns the same defined in PropertyDefinition.getValueConstraints().

Those that are namespace prefix mapping sensitive (e.g. NameConstraint, PathConstraint and ReferenceConstraint) return an internal string.

Specified by:

getString in interface QValueConstraint

Returns:

the internal definition String

See Also:

QValueConstraint.getString()

toString

public java.lang.String toString()

Same as getString()

Overrides:

toString in class java.lang.Object

Returns:

the internal definition String

See Also:

Object.toString()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Returns the hashCode of the definition String

Overrides:

hashCode in class java.lang.Object

Returns:

the hashCode of the definition String

See Also:

Object.hashCode()

create

public static ValueConstraint create(int type,
                                     java.lang.String definition)
                              throws InvalidConstraintException

Create a new ValueConstraint from the String representation. Note, that the definition must be independent of session specific namespace mappings in case of the following constraint types:

• PropertyType.NAME,
• PropertyType.PATH or
• PropertyType.REFERENCE

Parameters:

type - required type

definition - The internal definition string.

Returns:

a new value constraint

Throws:

InvalidConstraintException - if the constraint is not valid.

See Also:

for the corresponding method that allows to pass the JCR representation of a constraint definition.

create

public static ValueConstraint[] create(int type,
                                       java.lang.String[] definition)
                                throws InvalidConstraintException

Create a new ValueConstraint array from the String representation. Note, that the definition must be in the internal format in case of the following types:

• PropertyType.NAME,
• PropertyType.PATH or
• PropertyType.REFERENCE

Parameters:

type - the required type

definition - internal definition strings

Returns:

the array of constraints

Throws:

InvalidConstraintException - if one of the constraints is invalid

create

public static ValueConstraint[] create(int type,
                                       java.lang.String[] jcrDefinition,
                                       NamePathResolver resolver)
                                throws InvalidConstraintException

Create a new ValueConstraint array from the specified JCR representations.

Parameters:

type - the required type

jcrDefinition - The definition strings as exposed through the JCR API.

resolver - name-path resolver

Returns:

the array of constraints

Throws:

InvalidConstraintException - if one of the constraints is invalid

create

public static ValueConstraint create(int type,
                                     java.lang.String jcrDefinition,
                                     NamePathResolver resolver)
                              throws InvalidConstraintException

Parameters:

type - required type

jcrDefinition - A JCR representation of a value constraint definition.

resolver - name-path resolver

Returns:

a new value constraint

Throws:

InvalidConstraintException - if the constraint is invalid

checkValueConstraints

public static void checkValueConstraints(QPropertyDefinition pd,
                                         QValue[] values)
                                  throws ConstraintViolationException,
                                         RepositoryException

Tests if the value constraints defined in the property definition pd are satisfied by the the specified values.

Note that the protected flag is not checked. Also note that no type conversions are attempted if the type of the given values does not match the required type as specified in the given definition.

Parameters:

pd - property definition

values - values to check

Throws:

ConstraintViolationException - if the constraints are violated

RepositoryException