org.apache.sling.hapi

Interface HApiUtil

public interface HApiUtil

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
HApiType	fromNode(ResourceResolver resolver, Node typeNode) Get a HApi type object from the javax.jcr.Node.
HApiType	fromPath(ResourceResolver resolver, java.lang.String type) Get a HApi type object from a type identifier.
MicrodataAttributeHelper	getHelper(ResourceResolver resolver, java.lang.String type) Get a new instance of AttributeHelper for the type identified by 'type'
Node	getTypeNode(ResourceResolver resolver, java.lang.String type) Get a HApi type object from a type identifier.

Field Detail

DEFAULT_RESOURCE_TYPE

static final java.lang.String DEFAULT_RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getTypeNode

Node getTypeNode(ResourceResolver resolver,
                 java.lang.String type)
          throws RepositoryException

Get a HApi type object from a type identifier.

The JCR node must be [nt:unstructured], a descendant of any of the HAPi search path defined by the HAPI_PATHS config and the sling:resourceType should be set to the value defined by the HAPI_RESOURCE_TYPE config

The first result is returned

Parameters:

resolver - The sling resource resolver object

type - The type identifier, which is either in the form of a jcr path, same as the path for . If the path cannot be resolved, type is treated like a fully qualified domain name, which has to match the "fqdn" property on the JCR node which represents the type.

Returns:

The first node that matches that type or null if none is found.

Throws:

RepositoryException

fromPath

HApiType fromPath(ResourceResolver resolver,
                  java.lang.String type)
           throws RepositoryException

Get a HApi type object from a type identifier.

The type identifier is resolved to a javax.jcr.Node and then #fromNode(org.apache.sling.api.resource.ResourceResolver, javax.jcr.Node) is called.

For restrictions on the javax.jcr.Node see getTypeNode(org.apache.sling.api.resource.ResourceResolver, String)

Parameters:

resolver - The sling resource resolver object

type - The type identifier, which is either in the form of a jcr path, same as the path for. If the path cannot be resolved, type is treated like a fully qualified domain name, which has to match the "fqdn" property on the JCR node which represents the type.

Returns:

The HApiType resolved from the type identifier

Throws:

javax.jcr.RepositoryException

RepositoryException

fromNode

HApiType fromNode(ResourceResolver resolver,
                  Node typeNode)
           throws RepositoryException

Get a HApi type object from the javax.jcr.Node.

The Node has the following properties:

• name: A 'Name' of the type (mandatory)
• description: A 'String' with the description text for this type (mandatory)
• fqdn: A 'String' with the fully qualified domain name; A namespace like a java package (mandatory)
• extends: A type identifier (either a path or a fqdn); (optional). This defines the parent type of this type
• parameter: A multivalue property to define a list of java-like generic types that can be used as types for properties; (optional)

The properties of this type are defined as children nodes.

The name of property node defines the name of the property for this type.

The children property nodes have the following properties:

• type: The type identifier (mandatory). Can be of type 'Name' or 'Path' See getTypeNode(org.apache.sling.api.resource.ResourceResolver, String) for the format of this value
• description: A 'String' with the description for this property (mandatory)
• multiple: A 'Boolean' that defines whether this property can exist multiple times on an object of this type (optional)

Parameters:

resolver - The resource resolver

typeNode - The jcr node of the HApi type

Returns:

The HApiType

Throws:

RepositoryException

getHelper

MicrodataAttributeHelper getHelper(ResourceResolver resolver,
                                   java.lang.String type)
                            throws RepositoryException

Get a new instance of AttributeHelper for the type identified by 'type'

Parameters:

resolver -

type - See getTypeNode(org.apache.sling.api.resource.ResourceResolver, String) for the format of the type identifier

Returns:

Throws:

RepositoryException