info.magnolia.jcr.util

Class NodeTypeTemplateUtil

java.lang.Object

info.magnolia.jcr.util.NodeTypeTemplateUtil

public class NodeTypeTemplateUtil
extends Object

Utility class used to create:
- NodeTypeTemplate.
- NodeDefinitionTemplate used to define a 'childNodeDefinition' on a NodeTypeTemplate.
- PropertyDefinitionTemplate used to define a 'propertyDefinition' on a NodeTypeTemplate.

Constructor Summary

Constructors

Constructor and Description
NodeTypeTemplateUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static javax.jcr.nodetype.NodeDefinitionTemplate	createChildNodeDefinition(javax.jcr.nodetype.NodeTypeManager nodeTypeManager, boolean isAutoCreated, boolean isMandatory, boolean isProtected, boolean allowSameNameSiblings, String defaultPrimaryTypeName, String name, int onParentVersion, String[] requiredPrimaryTypeNames) Create a NodeDefinitionTemplate set as 'childNodeDefinition' on a 'nodeType'.
static javax.jcr.nodetype.NodeTypeTemplate	createNodeType(javax.jcr.nodetype.NodeTypeManager nodeTypeManager, String name, String[] superTypeNames, boolean isMixin, boolean isOrderableChildNodes, String primaryItemName, boolean isQueryable) Create a NodeTypeTemplate used a NodeType definition.
static javax.jcr.nodetype.PropertyDefinitionTemplate	createPropertyDefinition(javax.jcr.nodetype.NodeTypeManager nodeTypeManager, String name, boolean isAutoCreated, boolean isFullTextSearchable, boolean isMandatory, boolean isMultiple, boolean hasProtectedStatus, boolean isQueryOrderable, int onParentVersion, int requiredType, String[] availableQueryOperators, String[] valueConstraints, javax.jcr.Value[] defaultValues) Create a PropertyDefinitionTemplate set as 'propertyDefinition' on a 'nodeType'.
static javax.jcr.nodetype.NodeTypeTemplate	createSimpleMixinNodeType(javax.jcr.nodetype.NodeTypeManager nodeTypeManager, String name, String superType, HashMap<String,Integer> propertyNameTypeMap) Create a simple mixin NodeTypeTemplate with a single supertype, no child nodes and several property. Property are set by defaultto - autoCreated="false" - mandatory="false" - onParentVersion="COPY" - protected="false" - multiple="false"
static javax.jcr.nodetype.NodeTypeTemplate	createSimpleNodeType(javax.jcr.nodetype.NodeTypeManager nodeTypeManager, String name, List<String> supertype) Create a simple NodeTypeTemplate with a list of supertype, one generic child node and two generic properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeTypeTemplateUtil

public NodeTypeTemplateUtil()

Method Detail

createSimpleMixinNodeType

public static javax.jcr.nodetype.NodeTypeTemplate createSimpleMixinNodeType(javax.jcr.nodetype.NodeTypeManager nodeTypeManager,
                                                            String name,
                                                            String superType,
                                                            HashMap<String,Integer> propertyNameTypeMap)
                                                                     throws javax.jcr.RepositoryException

Create a simple mixin NodeTypeTemplate with a single supertype, no child nodes and several property.
Property are set by defaultto
- autoCreated="false"
- mandatory="false"
- onParentVersion="COPY"
- protected="false"
- multiple="false"

Parameters:

name - set as NodeTypeTemplate's name, and property 'isMixin' is set to true.

superTyp - set as 'supertype' name.

propertyDefinition - create PropertyDefinitionTemplate

propertyNameTypeMap - defines:
- key : name of the property
- value: requiredType of the property as PropertyType constant.

Returns:

the created NodeTypeTemplate.

Throws:

javax.jcr.RepositoryException

createSimpleNodeType

public static javax.jcr.nodetype.NodeTypeTemplate createSimpleNodeType(javax.jcr.nodetype.NodeTypeManager nodeTypeManager,
                                                       String name,
                                                       List<String> supertype)
                                                                throws javax.jcr.RepositoryException

Create a simple NodeTypeTemplate with a list of supertype, one generic child node and two generic properties.

Throws:

javax.jcr.RepositoryException

createNodeType

public static javax.jcr.nodetype.NodeTypeTemplate createNodeType(javax.jcr.nodetype.NodeTypeManager nodeTypeManager,
                                                 String name,
                                                 String[] superTypeNames,
                                                 boolean isMixin,
                                                 boolean isOrderableChildNodes,
                                                 String primaryItemName,
                                                 boolean isQueryable)
                                                          throws javax.jcr.RepositoryException

Create a NodeTypeTemplate used a NodeType definition.

Throws:

javax.jcr.RepositoryException

createChildNodeDefinition

public static javax.jcr.nodetype.NodeDefinitionTemplate createChildNodeDefinition(javax.jcr.nodetype.NodeTypeManager nodeTypeManager,
                                                                  boolean isAutoCreated,
                                                                  boolean isMandatory,
                                                                  boolean isProtected,
                                                                  boolean allowSameNameSiblings,
                                                                  String defaultPrimaryTypeName,
                                                                  String name,
                                                                  int onParentVersion,
                                                                  String[] requiredPrimaryTypeNames)
                                                                           throws javax.jcr.RepositoryException

Create a NodeDefinitionTemplate set as 'childNodeDefinition' on a 'nodeType'.

Parameters:

name - if blank, set '*' as value.

onParentVersion - if not a valid OnParentVersionAction constant, set OnParentVersionAction.IGNORE as value.

Throws:

javax.jcr.RepositoryException

createPropertyDefinition

public static javax.jcr.nodetype.PropertyDefinitionTemplate createPropertyDefinition(javax.jcr.nodetype.NodeTypeManager nodeTypeManager,
                                                                     String name,
                                                                     boolean isAutoCreated,
                                                                     boolean isFullTextSearchable,
                                                                     boolean isMandatory,
                                                                     boolean isMultiple,
                                                                     boolean hasProtectedStatus,
                                                                     boolean isQueryOrderable,
                                                                     int onParentVersion,
                                                                     int requiredType,
                                                                     String[] availableQueryOperators,
                                                                     String[] valueConstraints,
                                                                     javax.jcr.Value[] defaultValues)
                                                                              throws javax.jcr.RepositoryException

Create a PropertyDefinitionTemplate set as 'propertyDefinition' on a 'nodeType'.

Parameters:

onParentVersion - if not a valid OnParentVersionAction constant, set OnParentVersionAction.IGNORE as value.

requiredType - if not a valid PropertyType constant, set PropertyType.STRING as value.

name - if blank, set '*' as value.

availableQueryOperators - if null or empty, do not set this value

defaultValues - if null or empty, do not set this value

valueConstraints - if null or empty, do not set this value

Throws:

javax.jcr.RepositoryException