Class NodeTypeTemplateImpl
- java.lang.Object
-
- org.apache.jackrabbit.spi.commons.nodetype.NodeTypeTemplateImpl
-
- All Implemented Interfaces:
NodeTypeDefinition
,NodeTypeTemplate
public class NodeTypeTemplateImpl extends java.lang.Object implements NodeTypeTemplate
ANodeTypeTemplateImpl
...
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NodeDefinition[]
getDeclaredChildNodeDefinitions()
Returns an array containing the child node definitions actually declared in this node type.PropertyDefinition[]
getDeclaredPropertyDefinitions()
Returns an array containing the property definitions actually declared in this node type.java.lang.String[]
getDeclaredSupertypeNames()
Returns the names of the supertypes actually declared in this node type.java.lang.String
getName()
Returns the name of the node type.java.util.List
getNodeDefinitionTemplates()
Returns a mutableList
ofNodeDefinitionTemplate
objects.java.lang.String
getPrimaryItemName()
Returns the name of the primary item (one of the child items of the nodes of this node type).java.util.List
getPropertyDefinitionTemplates()
Returns a mutableList
ofPropertyDefinitionTemplate
objects.boolean
hasOrderableChildNodes()
Returnstrue
if nodes of this type must support orderable child nodes; returnsfalse
otherwise.boolean
isAbstract()
Returnstrue
if this is an abstract node type; returnsfalse
otherwise.boolean
isMixin()
Returnstrue
if this is a mixin type; returnsfalse
if it is primary.boolean
isQueryable()
Returnstrue
if the node type is queryable, meaning that the available-query-operators, full-text-searchable and query-orderable attributes of its property definitions take effect.void
setAbstract(boolean abstractStatus)
Sets the abstract flag of the node type.void
setDeclaredSuperTypeNames(java.lang.String[] names)
Sets the names of the supertypes of the node type.void
setMixin(boolean mixin)
Sets the mixin flag of the node type.void
setName(java.lang.String name)
Sets the name of the node type.void
setOrderableChildNodes(boolean orderable)
Sets the orderable child nodes flag of the node type.void
setPrimaryItemName(java.lang.String name)
Sets the name of the primary item.void
setQueryable(boolean queryable)
Sets the queryable status of the node type.
-
-
-
Method Detail
-
setName
public void setName(java.lang.String name) throws ConstraintViolationException
Sets the name of the node type. This must be a JCR name in either qualified or expanded form.- Specified by:
setName
in interfaceNodeTypeTemplate
- Parameters:
name
- a JCR name.- Throws:
ConstraintViolationException
- ifname
is not a syntactically valid JCR name in either qualified or expanded form.
-
setDeclaredSuperTypeNames
public void setDeclaredSuperTypeNames(java.lang.String[] names) throws ConstraintViolationException
Sets the names of the supertypes of the node type. These must be a JCR names in either qualified or expanded form.- Specified by:
setDeclaredSuperTypeNames
in interfaceNodeTypeTemplate
- Parameters:
names
- an array of JCR names.- Throws:
ConstraintViolationException
- ifnames
includes a name that is not a syntactically valid JCR name in either qualified or expanded form.
-
setAbstract
public void setAbstract(boolean abstractStatus)
Sets the abstract flag of the node type.- Specified by:
setAbstract
in interfaceNodeTypeTemplate
- Parameters:
abstractStatus
- aboolean
.
-
setMixin
public void setMixin(boolean mixin)
Sets the mixin flag of the node type.- Specified by:
setMixin
in interfaceNodeTypeTemplate
- Parameters:
mixin
- aboolean
.
-
setOrderableChildNodes
public void setOrderableChildNodes(boolean orderable)
Sets the orderable child nodes flag of the node type.- Specified by:
setOrderableChildNodes
in interfaceNodeTypeTemplate
- Parameters:
orderable
- aboolean
.
-
setPrimaryItemName
public void setPrimaryItemName(java.lang.String name) throws ConstraintViolationException
Sets the name of the primary item. This must be a JCR name in either qualified or expanded form.- Specified by:
setPrimaryItemName
in interfaceNodeTypeTemplate
- Parameters:
name
- a JCR name.- Throws:
ConstraintViolationException
- ifname
is not a syntactically valid JCR name in either qualified or expanded form.
-
getPropertyDefinitionTemplates
public java.util.List getPropertyDefinitionTemplates()
Returns a mutableList
ofPropertyDefinitionTemplate
objects. To define a newNodeTypeTemplate
or change an existing one,PropertyDefinitionTemplate
objects can be added to or removed from thisList
.- Specified by:
getPropertyDefinitionTemplates
in interfaceNodeTypeTemplate
- Returns:
- a mutable
List
ofPropertyDefinitionTemplate
objects.
-
getNodeDefinitionTemplates
public java.util.List getNodeDefinitionTemplates()
Returns a mutableList
ofNodeDefinitionTemplate
objects. To define a newNodeTypeTemplate
or change an existing one,NodeDefinitionTemplate
objects can be added to or removed from thisList
.- Specified by:
getNodeDefinitionTemplates
in interfaceNodeTypeTemplate
- Returns:
- a mutable
List
ofNodeDefinitionTemplate
objects.
-
setQueryable
public void setQueryable(boolean queryable)
Sets the queryable status of the node type.- Specified by:
setQueryable
in interfaceNodeTypeTemplate
- Parameters:
queryable
- aboolean
.
-
getName
public java.lang.String getName()
Returns the name of the node type.In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created emptyNodeTypeTemplate
, then this method will returnnull
.- Specified by:
getName
in interfaceNodeTypeDefinition
- Returns:
- a
String
-
getDeclaredSupertypeNames
public java.lang.String[] getDeclaredSupertypeNames()
Returns the names of the supertypes actually declared in this node type.In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created emptyNodeTypeTemplate
, then this method will return an empty array.- Specified by:
getDeclaredSupertypeNames
in interfaceNodeTypeDefinition
- Returns:
- an array of
String
s
-
isAbstract
public boolean isAbstract()
Returnstrue
if this is an abstract node type; returnsfalse
otherwise.An abstract node type is one that cannot be assigned as the primary or mixin type of a node but can be used in the definitions of other node types as a superclass.
In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created emptyNodeTypeTemplate
, then this method will returnfalse
.- Specified by:
isAbstract
in interfaceNodeTypeDefinition
- Returns:
- a
boolean
-
isMixin
public boolean isMixin()
Returnstrue
if this is a mixin type; returnsfalse
if it is primary.In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created emptyNodeTypeTemplate
, then this method will returnfalse
.- Specified by:
isMixin
in interfaceNodeTypeDefinition
- Returns:
- a
boolean
-
isQueryable
public boolean isQueryable()
Description copied from interface:NodeTypeDefinition
Returnstrue
if the node type is queryable, meaning that the available-query-operators, full-text-searchable and query-orderable attributes of its property definitions take effect. SeePropertyDefinition.getAvailableQueryOperators()
,PropertyDefinition.isFullTextSearchable()
andPropertyDefinition.isQueryOrderable()
.If a node type is declared non-queryable then these attributes of its property definitions have no effect.
In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created emptyNodeTypeTemplate
, then this method will return an implementation-determined defalt value.- Specified by:
isQueryable
in interfaceNodeTypeDefinition
- Returns:
- a
boolean
-
hasOrderableChildNodes
public boolean hasOrderableChildNodes()
Returnstrue
if nodes of this type must support orderable child nodes; returnsfalse
otherwise. If a node type returnstrue
on a call to this method, then all nodes of that node type must support the methodNode.orderBefore
. If a node type returnsfalse
on a call to this method, then nodes of that node type may supportNode.orderBefore
. Only the primary node type of a node controls that node's status in this regard. This setting on a mixin node type will not have any effect on the node.In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created emptyNodeTypeTemplate
, then this method will returnfalse
.- Specified by:
hasOrderableChildNodes
in interfaceNodeTypeDefinition
- Returns:
- a
boolean
-
getPrimaryItemName
public java.lang.String getPrimaryItemName()
Returns the name of the primary item (one of the child items of the nodes of this node type). If this node has no primary item, then this method returnsnull
. This indicator is used by the methodNode.getPrimaryItem()
.In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created emptyNodeTypeTemplate
, then this method will returnnull
.- Specified by:
getPrimaryItemName
in interfaceNodeTypeDefinition
- Returns:
- a
String
-
getDeclaredPropertyDefinitions
public PropertyDefinition[] getDeclaredPropertyDefinitions()
Returns an array containing the property definitions actually declared in this node type.In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created emptyNodeTypeTemplate
, then this method will returnnull
.- Specified by:
getDeclaredPropertyDefinitions
in interfaceNodeTypeDefinition
- Returns:
- an array of
PropertyDefinition
s
-
getDeclaredChildNodeDefinitions
public NodeDefinition[] getDeclaredChildNodeDefinitions()
Returns an array containing the child node definitions actually declared in this node type.In implementations that support node type registration, if this
NodeTypeDefinition
object is actually a newly-created emptyNodeTypeTemplate
, then this method will returnnull
.- Specified by:
getDeclaredChildNodeDefinitions
in interfaceNodeTypeDefinition
- Returns:
- an array of
NodeDefinition
s
-
-