org.ametys.cms.repository

Class ContentFactory

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.repository.jcr.SimpleAmetysObjectFactory

org.ametys.plugins.repository.jcr.DefaultAmetysObjectFactory

org.ametys.cms.repository.ContentFactory

All Implemented Interfaces:

AmetysObjectFactory<SimpleAmetysObject>, JCRAmetysObjectFactory<SimpleAmetysObject>, Component, Configurable, LogEnabled, Serviceable

Direct Known Subclasses:

DefaultWebContentFactory, DefaultWorkflowAwareContentFactory, ModifiableContentFactory

public class ContentFactory
extends DefaultAmetysObjectFactory

AmetysObjectFactory handling DefaultContent.

Field Summary

Fields

Modifier and Type	Field and Description
private ContentDAO	_contentDAO
private ModifiableContentHelper	_modifiableContentHelper

Fields inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObjectFactory

_ametysFactoryExtensionPoint, _manager, _nodetype, _repository, _resolver, _scheme

Constructor Summary

Constructors

Constructor and Description
ContentFactory()

Method Summary

Modifier and Type	Method and Description
(package private) AmetysObjectResolver	_getAOResolver()
(package private) ContentDAO	_getContentDAO()
(package private) ModifiableContentHelper	_getModifiableContentHelper()
<A extends AmetysObject> A	createChild(DefaultContent object, String name, String type) Creates a child to the given object.
DefaultContent	getAmetysObject(Node node, String parentPath) Creates a AmetysObject from a persistent JCR node.
<A extends AmetysObject> A	getChild(DefaultContent object, String path) Returns the AmetysObject at the given subPath, relative to the given DefaultTraversableAmetysObject.
<A extends AmetysObject> AmetysObjectIterable<A>	getChildren(DefaultContent object) Returns all children of the given DefaultTraversableAmetysObject.
boolean	hasChild(DefaultContent object, String name) Tests if a given object has a child with a given name.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObjectFactory

getCurrentUser, getWorkspaceNode

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObjectFactory

configure, getAmetysObjectById, getAmetysObjectById, getNode, getNodetypes, getParent, getScheme, hasAmetysObjectForId

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_contentDAO

private ContentDAO _contentDAO

_modifiableContentHelper

private ModifiableContentHelper _modifiableContentHelper

Constructor Detail

ContentFactory

public ContentFactory()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class DefaultAmetysObjectFactory

Throws:

ServiceException

_getContentDAO

ContentDAO _getContentDAO()

_getAOResolver

AmetysObjectResolver _getAOResolver()

_getModifiableContentHelper

ModifiableContentHelper _getModifiableContentHelper()

getAmetysObject

public DefaultContent getAmetysObject(Node node,
                                      String parentPath)
                               throws AmetysRepositoryException

Description copied from interface: JCRAmetysObjectFactory

Creates a AmetysObject from a persistent JCR node.

Specified by:

getAmetysObject in interface JCRAmetysObjectFactory<SimpleAmetysObject>

Overrides:

getAmetysObject in class DefaultAmetysObjectFactory

Parameters:

node - the JCR node to use.

parentPath - the parent Path in the Ametys hierarchy, may be null if not known yet.

Returns:

the object.

Throws:

AmetysRepositoryException - if an error occurs.

getChild

public <A extends AmetysObject> A getChild(DefaultContent object,
                                           String path)
                                    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.

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

Returns:

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

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if no such object exists.

getChildren

public <A extends AmetysObject> AmetysObjectIterable<A> getChildren(DefaultContent object)
                                                             throws AmetysRepositoryException

Returns all children of the given DefaultTraversableAmetysObject.

Type Parameters:

A - the actual type of AmetysObjects

Parameters:

object - a DefaultTraversableAmetysObject.

Returns:

a List containing all children object in the Ametys hierarchy.

Throws:

AmetysRepositoryException - if an error occurs.

hasChild

public boolean hasChild(DefaultContent object,
                        String name)
                 throws AmetysRepositoryException

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

Parameters:

object - the context object.

name - the name to test.

Returns:

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

Throws:

AmetysRepositoryException - if an error occurs.

createChild

public <A extends AmetysObject> A createChild(DefaultContent object,
                                              String name,
                                              String type)
                                       throws AmetysRepositoryException

Creates a child to the given object.

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

object - the parent AmetysObject.

name - the new object's name.

type - the new object's type.

Returns:

the newly created AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.