org.apache.jackrabbit.spi
Interface QItemDefinition

All Known Subinterfaces:
QNodeDefinition, QPropertyDefinition
All Known Implementing Classes:
QItemDefinitionImpl, QNodeDefinitionImpl, QPropertyDefinitionImpl

public interface QItemDefinition

QItemDefinition is the SPI representation of an item definition. It refers to Names only and is thus isolated from session-specific namespace mappings.

See Also:
ItemDefinition

Field Summary
static QItemDefinition[] EMPTY_ARRAY
          Empty array of QItemDefinition.
 
Method Summary
 boolean definesNode()
          Determines whether this item definition defines a node.
 boolean definesResidual()
          Determines whether this item definition defines a residual set of child items.
 Name getDeclaringNodeType()
          Gets the name of the declaring node type.
 Name getName()
          Gets the name of the child item.
 int getOnParentVersion()
          Gets the 'onParentVersion' attribute of the item.
 boolean isAutoCreated()
          Determines whether the item is 'autoCreated'.
 boolean isMandatory()
          Determines whether the item is 'mandatory'.
 boolean isProtected()
          Determines whether the item is 'protected'.
 

Field Detail

EMPTY_ARRAY

static final QItemDefinition[] EMPTY_ARRAY
Empty array of QItemDefinition.

Method Detail

getName

Name getName()
Gets the name of the child item.

Returns:
the name of the child item.

getDeclaringNodeType

Name getDeclaringNodeType()
Gets the name of the declaring node type.

Returns:
the name of the declaring node type.

isAutoCreated

boolean isAutoCreated()
Determines whether the item is 'autoCreated'.

Returns:
the 'autoCreated' flag.

getOnParentVersion

int getOnParentVersion()
Gets the 'onParentVersion' attribute of the item.

Returns:
the 'onParentVersion' attribute.

isProtected

boolean isProtected()
Determines whether the item is 'protected'.

Returns:
the 'protected' flag.

isMandatory

boolean isMandatory()
Determines whether the item is 'mandatory'.

Returns:
the 'mandatory' flag.

definesResidual

boolean definesResidual()
Determines whether this item definition defines a residual set of child items.

Returns:
true if this definition defines a residual set; false otherwise.

definesNode

boolean definesNode()
Determines whether this item definition defines a node.

Returns:
true if this is a node definition; false otherwise (i.e. it is a property definition).


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