org.apache.sling.hapi.impl

Class HApiUtilImpl

java.lang.Object

org.apache.sling.hapi.impl.HApiUtilImpl

All Implemented Interfaces:

HApiUtil

public class HApiUtilImpl
extends Object
implements HApiUtil

Field Summary

Fields inherited from interface org.apache.sling.hapi.HApiUtil

COLLECTION_RESOURCE_TYPE, COLLECTION_RESOURCE_TYPE_DESC, DEFAULT_COLLECTION_RESOURCE_TYPE, DEFAULT_ENABLED, DEFAULT_RESOURCE_TYPE, DEFAULT_SEARCH_PATH, DEFAULT_SERVER_URL, ENABLED, ENABLED_DESC, EXTERNAL_URL, EXTERNAL_URL_DESC, RESOURCE_TYPE, RESOURCE_TYPE_DESC, SEARCH_PATHS, SEARCH_PATHS_DESC

Constructor Summary

Constructors

Constructor and Description
HApiUtilImpl()

Method Summary

Modifier and Type	Method and Description
HApiTypesCollection	collectionFromPath(org.apache.sling.api.resource.ResourceResolver resolver, String collectionPath) Get a HApiTypesCollection object from a path String.
HApiTypesCollection	collectionFromResource(org.apache.sling.api.resource.ResourceResolver resolver, org.apache.sling.api.resource.Resource collectionResource) Get a HApiTypesCollection object from a Resource.
HApiType	fromNode(org.apache.sling.api.resource.ResourceResolver resolver, javax.jcr.Node typeNode) Deprecated.
HApiType	fromPath(org.apache.sling.api.resource.ResourceResolver resolver, String type) Get a HApi type object from a type identifier.
HApiType	fromResource(org.apache.sling.api.resource.ResourceResolver resolver, org.apache.sling.api.resource.Resource typeResource) Get a HApi type object from the Resource.
MicrodataAttributeHelper	getHelper(org.apache.sling.api.resource.ResourceResolver resolver, String type) Get a new instance of AttributeHelper for the type identified by 'type'
org.apache.sling.api.resource.Resource	getTypeCollectionResource(org.apache.sling.api.resource.ResourceResolver resolver, String collection) Get a HApi type collection Resource from a collection identifier.
javax.jcr.Node	getTypeNode(org.apache.sling.api.resource.ResourceResolver resolver, String type) Deprecated.
org.apache.sling.api.resource.Resource	getTypeResource(org.apache.sling.api.resource.ResourceResolver resolver, String type) Get a HApi type Resource from a type identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

HApiUtilImpl

public HApiUtilImpl()

Method Detail

getTypeNode

@Deprecated
public javax.jcr.Node getTypeNode(org.apache.sling.api.resource.ResourceResolver resolver,
                                              String type)
                                       throws javax.jcr.RepositoryException

Deprecated.

Get a HApi type jcr node 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

Specified by:

getTypeNode in interface HApiUtil

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:

javax.jcr.RepositoryException

getTypeResource

public org.apache.sling.api.resource.Resource getTypeResource(org.apache.sling.api.resource.ResourceResolver resolver,
                                                              String type)

Get a HApi type Resource from a type identifier.

The Resource 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 HapiUtil#RESOURCE_TYPE config

The first result is returned

Specified by:

getTypeResource in interface HApiUtil

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 Resource which represents the type.

Returns:

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

getTypeCollectionResource

public org.apache.sling.api.resource.Resource getTypeCollectionResource(org.apache.sling.api.resource.ResourceResolver resolver,
                                                                        String collection)

Get a HApi type collection Resource from a collection identifier.

The Resource 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 HapiUtil#COLLECTION_RESOURCE_TYPE config

The first result is returned

Specified by:

getTypeCollectionResource in interface HApiUtil

Parameters:

resolver - The sling resource resolver object

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

Returns:

The first Resource that matches that collection or null if none is found.

fromPath

public HApiType fromPath(org.apache.sling.api.resource.ResourceResolver resolver,
                         String type)
                  throws javax.jcr.RepositoryException

Get a HApi type object from a type identifier.

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

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

Specified by:

fromPath in interface HApiUtil

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

fromNode

@Deprecated
public HApiType fromNode(org.apache.sling.api.resource.ResourceResolver resolver,
                                     javax.jcr.Node typeNode)
                              throws javax.jcr.RepositoryException

Deprecated.

Get a HApi type object from the 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 HApiUtil.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)

Specified by:

fromNode in interface HApiUtil

Parameters:

resolver - The resource resolver

typeNode - The jcr node of the HApi type

Returns:

The HApiType

Throws:

javax.jcr.RepositoryException

fromResource

public HApiType fromResource(org.apache.sling.api.resource.ResourceResolver resolver,
                             org.apache.sling.api.resource.Resource typeResource)
                      throws javax.jcr.RepositoryException

Get a HApi type object from the Resource.

The Resource 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 resources.

The name of property resource 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 HApiUtil.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)

Specified by:

fromResource in interface HApiUtil

Parameters:

resolver - The resource resolver

typeResource - The sling Resource of the HApi type

Returns:

The HApiType

Throws:

javax.jcr.RepositoryException

collectionFromResource

public HApiTypesCollection collectionFromResource(org.apache.sling.api.resource.ResourceResolver resolver,
                                                  org.apache.sling.api.resource.Resource collectionResource)
                                           throws javax.jcr.RepositoryException

Get a HApiTypesCollection object from a Resource.

The Resource has the following properties:

• name: A 'Name' of the type collection (mandatory)
• description: A 'String' with the description text for this type collection (mandatory)
• fqdn: A 'String' with the fully qualified domain name; A namespace like a java package (mandatory)

The types collection will be populated with direct child Resources of the {{collectionResource}}, which have the resourceType equal to the value of the HApiUtil.RESOURCE_TYPE property

Specified by:

collectionFromResource in interface HApiUtil

Parameters:

resolver - The resource resolver

collectionResource - The sling Resource of the HApi type collection

Returns:

The HApiTypesCollection

Throws:

javax.jcr.RepositoryException

collectionFromPath

public HApiTypesCollection collectionFromPath(org.apache.sling.api.resource.ResourceResolver resolver,
                                              String collectionPath)
                                       throws javax.jcr.RepositoryException

Get a HApiTypesCollection object from a path String.

HApiUtil.collectionFromResource(org.apache.sling.api.resource.ResourceResolver, org.apache.sling.api.resource.Resource)

Specified by:

collectionFromPath in interface HApiUtil

Parameters:

resolver - The resource resolver

collectionPath - The sling resource path of the HApi type collection

Returns:

The HApiTypesCollection

Throws:

javax.jcr.RepositoryException

getHelper

public MicrodataAttributeHelper getHelper(org.apache.sling.api.resource.ResourceResolver resolver,
                                          String type)
                                   throws javax.jcr.RepositoryException

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

Specified by:

getHelper in interface HApiUtil

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

Returns:

Throws:

javax.jcr.RepositoryException