org.apache.sling.jcr.resource

Class JcrResourceUtil

java.lang.Object

org.apache.sling.jcr.resource.JcrResourceUtil

public class JcrResourceUtil
extends Object

The JcrResourceUtil class provides helper methods used throughout this bundle.

Constructor Summary

Constructors

Constructor and Description
JcrResourceUtil()

Method Summary

Modifier and Type	Method and Description
static javax.jcr.Node	createPath(javax.jcr.Node parentNode, String relativePath, String intermediateNodeType, String nodeType, boolean autoSave) Creates or gets the Node at the given Path.
static javax.jcr.Node	createPath(String path, String intermediateNodeType, String nodeType, javax.jcr.Session session, boolean autoSave) Creates or gets the Node at the given Path.
static javax.jcr.Value	createValue(Object value, javax.jcr.Session session) Creates a JCR Value for the given object with the given Session.
static String	getResourceSuperType(Resource resource) Deprecated. Call ResourceUtil.findResourceSuperType(Resource)
static String	getResourceSuperType(ResourceResolver resourceResolver, String resourceType) Deprecated. Use ResourceUtil.getResourceSuperType(ResourceResolver, String)
static javax.jcr.query.QueryResult	query(javax.jcr.Session session, String query, String language) Helper method to execute a JCR query.
static String	resourceTypeToPath(String type) Deprecated. Use ResourceUtil.resourceTypeToPath(String)
static void	setProperty(javax.jcr.Node node, String propertyName, Object propertyValue) Sets the value of the property.
static Object	toJavaObject(javax.jcr.Property property) Converts the value(s) of a JCR Property to a corresponding Java Object.
static Object	toJavaObject(javax.jcr.Value value) Converts a JCR Value to a corresponding Java Object

Methods inherited from class java.lang.Object

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

Constructor Detail

JcrResourceUtil

public JcrResourceUtil()

Method Detail

query

public static javax.jcr.query.QueryResult query(javax.jcr.Session session,
                                                String query,
                                                String language)
                                         throws javax.jcr.RepositoryException

Helper method to execute a JCR query.

Parameters:

session - the session

query - the query

language - the language

Returns:

the query's result

Throws:

javax.jcr.RepositoryException - if the QueryManager cannot be retrieved

toJavaObject

public static Object toJavaObject(javax.jcr.Value value)
                           throws javax.jcr.RepositoryException

Converts a JCR Value to a corresponding Java Object

Parameters:

value - the JCR Value to convert

Returns:

the Java Object

Throws:

javax.jcr.RepositoryException - if the value cannot be converted

toJavaObject

public static Object toJavaObject(javax.jcr.Property property)
                           throws javax.jcr.RepositoryException

Converts the value(s) of a JCR Property to a corresponding Java Object. If the property has multiple values the result is an array of Java Objects representing the converted values of the property.

Parameters:

property - the property to be converted to the corresponding Java Object

Returns:

the Object resulting from the conversion

Throws:

javax.jcr.RepositoryException - if the conversion cannot take place

createValue

public static javax.jcr.Value createValue(Object value,
                                          javax.jcr.Session session)
                                   throws javax.jcr.RepositoryException

Creates a JCR Value for the given object with the given Session. Selects the the PropertyType according the instance of the object's Class

Parameters:

value - object

session - to create value for

Returns:

the value or null if not convertible to a valid PropertyType

Throws:

javax.jcr.RepositoryException - in case of error, accessing the Repository

setProperty

public static void setProperty(javax.jcr.Node node,
                               String propertyName,
                               Object propertyValue)
                        throws javax.jcr.RepositoryException

Sets the value of the property. Selects the PropertyType according to the instance of the object's class.

Parameters:

node - The node where the property will be set on.

propertyName - The name of the property.

propertyValue - The value for the property.

Throws:

javax.jcr.RepositoryException - if the property cannot be set

resourceTypeToPath

@Deprecated
public static String resourceTypeToPath(String type)

Deprecated. Use ResourceUtil.resourceTypeToPath(String)

Helper method, which returns the given resource type as returned from the Resource.getResourceType() as a relative path.

Parameters:

type - The resource type to be converted into a path

Returns:

The resource type as a path.

getResourceSuperType

@Deprecated
public static String getResourceSuperType(ResourceResolver resourceResolver,
                                                      String resourceType)

Deprecated. Use ResourceUtil.getResourceSuperType(ResourceResolver, String)

Returns the super type of the given resource type. This is the result of adapting the child resource JcrResourceConstants.SLING_RESOURCE_SUPER_TYPE_PROPERTY of the Resource addressed by the resourceType to a string. If no such child resource exists or if the resource does not adapt to a string, this method returns null.

Parameters:

resourceResolver - The ResourceResolver used to access the resource whose path (relative or absolute) is given by the resourceType parameter.

resourceType - The resource type whose super type is to be returned. This type is turned into a path by calling the resourceTypeToPath(String) method before trying to get the resource through the resourceResolver.

Returns:

the super type of the resourceType or null if the resource type does not have a child resource JcrResourceConstants.SLING_RESOURCE_SUPER_TYPE_PROPERTY adapting to a string.

getResourceSuperType

@Deprecated
public static String getResourceSuperType(Resource resource)

Deprecated. Call ResourceUtil.findResourceSuperType(Resource)

Returns the resource super type of the given resource. This is either the child resource JcrResourceConstants.SLING_RESOURCE_SUPER_TYPE_PROPERTY if the given resource adapted to a string or the result of calling the getResourceSuperType(ResourceResolver, String) method on the resource type of the resource.

This mechanism allows to specifically set the resource super type on a per-resource level overwriting any resource super type hierarchy pre-defined by the actual resource type of the resource.

Parameters:

resource - The Resource whose resource super type is requested.

Returns:

The resource super type or null if the algorithm described above does not yield a resource super type.

createPath

public static javax.jcr.Node createPath(String path,
                                        String intermediateNodeType,
                                        String nodeType,
                                        javax.jcr.Session session,
                                        boolean autoSave)
                                 throws javax.jcr.RepositoryException

Creates or gets the Node at the given Path. In case it has to create the Node all non-existent intermediate path-elements will be create with the given intermediate node type and the returned node will be created with the given nodeType

Parameters:

path - to create

intermediateNodeType - to use for creation of intermediate nodes (or null)

nodeType - to use for creation of the final node (or null)

session - to use

autoSave - Should save be called when a new node is created?

Returns:

the Node at path

Throws:

javax.jcr.RepositoryException - in case of exception accessing the Repository

createPath

public static javax.jcr.Node createPath(javax.jcr.Node parentNode,
                                        String relativePath,
                                        String intermediateNodeType,
                                        String nodeType,
                                        boolean autoSave)
                                 throws javax.jcr.RepositoryException

Creates or gets the Node at the given Path. In case it has to create the Node all non-existent intermediate path-elements will be create with the given intermediate node type and the returned node will be created with the given nodeType

Parameters:

parentNode - starting node

relativePath - to create

intermediateNodeType - to use for creation of intermediate nodes (or null)

nodeType - to use for creation of the final node (or null)

autoSave - Should save be called when a new node is created?

Returns:

the Node at path

Throws:

javax.jcr.RepositoryException - in case of exception accessing the Repository