org.apache.jackrabbit.core
Class ItemValidator

java.lang.Object
  org.apache.jackrabbit.core.ItemValidator

Direct Known Subclasses:

BatchedItemOperations

public class ItemValidator
extends java.lang.Object

Utility class for validating an item against constraints specified by its definition.

Field Summary

protected HierarchyManager	hierMgr hierarchy manager used for generating error msg's that contain human readable paths
protected NodeTypeRegistry	ntReg node type registry
protected PathResolver	resolver Path resolver for outputting user-friendly error messages.

Constructor Summary

ItemValidator(NodeTypeRegistry ntReg, HierarchyManager hierMgr, PathResolver resolver)
Creates a new ItemValidator instance.

Method Summary

EffectiveNodeType	getEffectiveNodeType(NodeState state) Helper method that builds the effective (i.e.
java.lang.String	safeGetJCRPath(ItemId id) Failsafe translation of internal ItemId to JCR path for use in error messages etc.
java.lang.String	safeGetJCRPath(Path path) Failsafe conversion of internal Path to JCR path for use in error messages etc.
void	validate(NodeState nodeState) Checks whether the given node state satisfies the constraints specified by its primary and mixin node types.
void	validate(PropertyState propState) Checks whether the given property state satisfies the constraints specified by its definition.

Methods inherited from class java.lang.Object

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

Field Detail

ntReg

protected final NodeTypeRegistry ntReg

node type registry

hierMgr

protected final HierarchyManager hierMgr

hierarchy manager used for generating error msg's that contain human readable paths

See Also:

safeGetJCRPath(ItemId)

resolver

protected final PathResolver resolver

Path resolver for outputting user-friendly error messages.

Constructor Detail

ItemValidator

public ItemValidator(NodeTypeRegistry ntReg,
                     HierarchyManager hierMgr,
                     PathResolver resolver)

Creates a new ItemValidator instance.

Parameters:

ntReg - node type registry

hierMgr - hierarchy manager

resolver - path resolver

Method Detail

validate

public void validate(NodeState nodeState)
              throws javax.jcr.nodetype.ConstraintViolationException,
                     javax.jcr.RepositoryException

Checks whether the given node state satisfies the constraints specified by its primary and mixin node types. The following validations/checks are performed:

• check if its node type satisfies the 'required node types' constraint specified in its definition
• check if all 'mandatory' child items exist
• for every property: check if the property value satisfies the value constraints specified in the property's definition

Parameters:

nodeState - state of node to be validated

Throws:

javax.jcr.nodetype.ConstraintViolationException - if any of the validations fail

javax.jcr.RepositoryException - if another error occurs

validate

public void validate(PropertyState propState)
              throws javax.jcr.nodetype.ConstraintViolationException,
                     javax.jcr.RepositoryException

Checks whether the given property state satisfies the constraints specified by its definition. The following validations/checks are performed:

• check if the type of the property values does comply with the requiredType specified in the property's definition
• check if the property values satisfy the value constraints specified in the property's definition

Parameters:

propState - state of property to be validated

Throws:

javax.jcr.nodetype.ConstraintViolationException - if any of the validations fail

javax.jcr.RepositoryException - if another error occurs

getEffectiveNodeType

public EffectiveNodeType getEffectiveNodeType(NodeState state)
                                       throws javax.jcr.RepositoryException

Helper method that builds the effective (i.e. merged and resolved) node type representation of the specified node's primary and mixin node types.

Parameters:

state -

Returns:

the effective node type

Throws:

javax.jcr.RepositoryException

safeGetJCRPath

public java.lang.String safeGetJCRPath(Path path)

Failsafe conversion of internal Path to JCR path for use in error messages etc.

Parameters:

path - path to convert

Returns:

JCR path

safeGetJCRPath

public java.lang.String safeGetJCRPath(ItemId id)

Failsafe translation of internal ItemId to JCR path for use in error messages etc.

Parameters:

id - id to translate

Returns:

JCR path