org.ametys.plugins.repository.jcr

Class TraversableAmetysObjectHelper

java.lang.Object

org.ametys.plugins.repository.jcr.TraversableAmetysObjectHelper

public final class TraversableAmetysObjectHelper
extends Object

Helper for implementing TraversableAmetysObject stored in JCR.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TraversableAmetysObjectHelper()

Method Summary

Modifier and Type	Method and Description
private static void	_checkLock(Node node)
private static String	_computeSubPath(String[] pathElements, int beginIndex)
private static String	_escape(String qName)
private static VirtualAmetysObjectFactory	_getVirtualFactory(String id, AmetysObjectFactoryExtensionPoint ametysFactoryExtensionPoint, Logger logger)
static <A extends AmetysObject> A	createChild(JCRTraversableAmetysObject object, JCRAmetysObjectFactory factory, String name, String type, AmetysObjectFactoryExtensionPoint ametysFactoryExtensionPoint, AmetysObjectResolver resolver, Logger logger) Creates a child to the given object.
static <A extends AmetysObject> A	getChild(JCRTraversableAmetysObject object, JCRAmetysObjectFactory factory, String path, AmetysObjectResolver resolver, Logger logger) Returns the AmetysObject at the given subPath, relative to the given DefaultTraversableAmetysObject.
static <A extends AmetysObject> AmetysObjectIterable<A>	getChildren(JCRTraversableAmetysObject object, JCRAmetysObjectFactory factory, AmetysObjectResolver resolver, Logger logger) Returns all children of the given DefaultTraversableAmetysObject.
static boolean	hasChild(JCRTraversableAmetysObject object, String name, AmetysObjectFactoryExtensionPoint ametysFactoryExtensionPoint, Logger logger) Tests if a given object has a child with a given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraversableAmetysObjectHelper

private TraversableAmetysObjectHelper()

Method Detail

getChild

public static <A extends AmetysObject> A getChild(JCRTraversableAmetysObject object,
                                                  JCRAmetysObjectFactory factory,
                                                  String path,
                                                  AmetysObjectResolver resolver,
                                                  Logger logger)
                                           throws AmetysRepositoryException,
                                                  UnknownAmetysObjectException

Returns the AmetysObject at the given subPath, relative to the given DefaultTraversableAmetysObject.

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

object - the context DefaultTraversableAmetysObject.

factory - the corresponding JCRAmetysObjectFactory.

path - the sub path. Cannot be null, empty or absolute.

resolver - the AmetysObjectResolver.

logger - a Logger for traces.

Returns:

the AmetysObject at the given subPath, relative to the given DefaultTraversableAmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if no such object exists.

_computeSubPath

private static String _computeSubPath(String[] pathElements,
                                      int beginIndex)

getChildren

public static <A extends AmetysObject> AmetysObjectIterable<A> getChildren(JCRTraversableAmetysObject object,
                                                                           JCRAmetysObjectFactory factory,
                                                                           AmetysObjectResolver resolver,
                                                                           Logger logger)
                                                                    throws AmetysRepositoryException

Returns all children of the given DefaultTraversableAmetysObject.

Type Parameters:

A - the actual type of AmetysObjects

Parameters:

object - a DefaultTraversableAmetysObject.

factory - the corresponding JCRAmetysObjectFactory.

resolver - the AmetysObjectResolver.

logger - a Logger for traces.

Returns:

a List containing all children object in the Ametys hierarchy.

Throws:

AmetysRepositoryException - if an error occurs.

hasChild

public static boolean hasChild(JCRTraversableAmetysObject object,
                               String name,
                               AmetysObjectFactoryExtensionPoint ametysFactoryExtensionPoint,
                               Logger logger)
                        throws AmetysRepositoryException

Tests if a given object has a child with a given name.

Parameters:

object - the context object.

name - the name to test.

ametysFactoryExtensionPoint - the AmetysObjectFactoryExtensionPoint.

logger - a Logger for traces.

Returns:

true is the given object has a child with the given name, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

_getVirtualFactory

private static VirtualAmetysObjectFactory _getVirtualFactory(String id,
                                                             AmetysObjectFactoryExtensionPoint ametysFactoryExtensionPoint,
                                                             Logger logger)

createChild

public static <A extends AmetysObject> A createChild(JCRTraversableAmetysObject object,
                                                     JCRAmetysObjectFactory factory,
                                                     String name,
                                                     String type,
                                                     AmetysObjectFactoryExtensionPoint ametysFactoryExtensionPoint,
                                                     AmetysObjectResolver resolver,
                                                     Logger logger)
                                              throws AmetysRepositoryException

Creates a child to the given object.

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

object - the parent AmetysObject.

factory - the corresponding JCRAmetysObjectFactory.

name - the new object's name.

type - the new object's type.

ametysFactoryExtensionPoint - the AmetysObjectFactoryExtensionPoint.

resolver - the AmetysObjectResolver.

logger - a Logger for traces.

Returns:

the newly created AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

_escape

private static String _escape(String qName)

_checkLock

private static void _checkLock(Node node)
                        throws RepositoryException

Throws:

RepositoryException