Package org.ametys.web.repository.page.jcr

Class DefaultZoneItem

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<DefaultZoneItemFactory>

org.ametys.web.repository.page.jcr.DefaultZoneItem

All Implemented Interfaces:

AmetysObject, CopiableAmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, ModifiableModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, ModifiableDataHolder, ModifiableModelLessDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableAmetysObject, MovableAmetysObject, RemovableAmetysObject, ModifiableZoneItem, ZoneItem

public class DefaultZoneItem
extends SimpleAmetysObject<DefaultZoneItemFactory>
implements ModifiableZoneItem, CopiableAmetysObject

implementation of a ModifiableZoneItem.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.web.repository.page.ZoneItem

ZoneItem.ZoneType

Field Summary

Fields

Modifier and Type	Field	Description
private static org.slf4j.Logger	__LOGGER
static String	METADATA_CONTENT	Constant for content metadata.
static String	METADATA_METADATASET_NAME	Deprecated. Use METADATA_VIEW_NAME instead
static String	METADATA_SERVICE	Constant for service metadata.
static String	METADATA_TYPE	Constant for title metadata.
static String	METADATA_VIEW_NAME	Constant for view name metadata.
static String	SERVICE_PARAM_NODETYPE	Constant service parameters node type.

Fields inherited from interface org.ametys.web.repository.page.ZoneItem

SERVICE_PARAMETERS_DATA_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultZoneItem(Node node, String parentPath, DefaultZoneItemFactory factory)	Creates a DefaultZoneItem.

Method Summary

Modifier and Type	Method	Description
protected ModifiableRepositoryData	_getServiceParametersRepositoryData()	Retrieves the ModifiableRepositoryData containing the service parameters of this zone item
boolean	canMoveTo(AmetysObject newParent)	Test if a move can be a success or if it is impossible (e.g.
ModifiableZoneItem	copyTo(ModifiableTraversableAmetysObject parent, String name)	Copy the current AmetysObject to the given object.
ModifiableZoneItem	copyTo(ModifiableTraversableAmetysObject parent, String name, List<String> restrictTo)	Copy the current AmetysObject to the given object if it is not in the restriction list.
void	dataToSAX(ContentHandler contentHandler, String dataPath, Locale locale)	Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path
void	dataToSAX(ContentHandler contentHandler, Locale locale)	Generates SAX events for data contained in this DataHolder
<C extends Content> C	getContent()	Retrieves the content reference.
ModifiableModelAwareDataHolder	getContentViewParametersHolder(String contentViewName)	Get the content view parameters for a given view
ModifiableModelLessDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
ModifiableCompositeMetadata	getMetadataHolder()	Returns the root CompositeMetadata of this AmetysObject.
String	getServiceId()	Retrieves the service id.
ModifiableModelAwareDataHolder	getServiceParameters()	Get the service parameters
ModifiableModelAwareDataHolder	getServiceViewParametersHolder(String serviceViewName)	Get the service view parameters for a given view
ZoneItem.ZoneType	getType()	Retrieves the type.
String	getViewName()	Get the name of the view to render the Content with.
Zone	getZone()	Get the parent zone.
ModifiableModelAwareDataHolder	getZoneItemParametersHolder()	Get the view parameters
void	moveTo(AmetysObject newParent, boolean renameIfExist)	Move the current object as a new child of the given object.
void	orderBefore(AmetysObject siblingObject)	Order a node before another sibling node (or as the last node)
<C extends Content> void	setContent(C content)	Set the content reference.
void	setServiceId(String serviceId)	Set the service id.
void	setType(ZoneItem.ZoneType type)	Set the type.
void	setViewName(String viewName)	Set the Content view name.

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

_getFactory, _invalidateName, _invalidateParentPath, getId, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, getDataNames, getRepositoryData

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

dataToSAX

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelLessDataAwareAmetysObject

getComposite, getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelLessDataHolder

dataToSAX, hasValue

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModifiableModelLessDataAwareAmetysObject

getComposite, getComposite, getRepositoryData, removeValue, setValue, setValue, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Field Detail

METADATA_TYPE

public static final String METADATA_TYPE

Constant for title metadata.

See Also:

Constant Field Values

METADATA_SERVICE

public static final String METADATA_SERVICE

Constant for service metadata.

See Also:

Constant Field Values

METADATA_CONTENT

public static final String METADATA_CONTENT

Constant for content metadata.

See Also:

Constant Field Values

SERVICE_PARAM_NODETYPE

public static final String SERVICE_PARAM_NODETYPE

Constant service parameters node type.

See Also:

Constant Field Values

METADATA_METADATASET_NAME

@Deprecated
public static final String METADATA_METADATASET_NAME

Deprecated.

Use METADATA_VIEW_NAME instead

Constant for "metadata set name" metadata.

See Also:

Constant Field Values

METADATA_VIEW_NAME

public static final String METADATA_VIEW_NAME

Constant for view name metadata. TODO NEWATTRIBUTEAPI_SERVICE: Change the name of this metadata to viewName (there may be a lot of impacts..)

See Also:

Constant Field Values

__LOGGER

private static final org.slf4j.Logger __LOGGER

Constructor Detail

DefaultZoneItem

public DefaultZoneItem(Node node,
                       String parentPath,
                       DefaultZoneItemFactory factory)

Creates a DefaultZoneItem.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the DefaultZoneItemFactory which creates the AmetysObject.

Method Detail

getType

public ZoneItem.ZoneType getType()
                          throws AmetysRepositoryException

Description copied from interface: ZoneItem

Retrieves the type.

Specified by:

getType in interface ZoneItem

Returns:

the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

ZoneItem.ZoneType

setType

public void setType(ZoneItem.ZoneType type)
             throws AmetysRepositoryException

Description copied from interface: ModifiableZoneItem

Set the type.

Specified by:

setType in interface ModifiableZoneItem

Parameters:

type - the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

ZoneItem.ZoneType

getContent

public <C extends Content> C getContent()
                                 throws AmetysRepositoryException

Description copied from interface: ZoneItem

Retrieves the content reference.

Specified by:

getContent in interface ZoneItem

Type Parameters:

C - the actual type of Content.

Returns:

the service id.

Throws:

AmetysRepositoryException - if an error occurs.

setContent

public <C extends Content> void setContent(C content)
                                    throws AmetysRepositoryException

Description copied from interface: ModifiableZoneItem

Set the content reference.

Specified by:

setContent in interface ModifiableZoneItem

Type Parameters:

C - the actual type of Content.

Parameters:

content - the content.

Throws:

AmetysRepositoryException - if an error occurs.

getViewName

public String getViewName()
                   throws AmetysRepositoryException

Description copied from interface: ZoneItem

Get the name of the view to render the Content with. It only makes sense if the ZoneItem is a Content reference.
If null is returned, in most cases, "main" should be assumed.

Specified by:

getViewName in interface ZoneItem

Returns:

the view name, or null if not set.

Throws:

AmetysRepositoryException - if an error occurs. TODO NEWATTRIBUTEAPI_SERVICE: remove the default implementation when all zone items implement the method

setViewName

public void setViewName(String viewName)
                 throws AmetysRepositoryException

Description copied from interface: ModifiableZoneItem

Set the Content view name.

Specified by:

setViewName in interface ModifiableZoneItem

Parameters:

viewName - the view name.

Throws:

AmetysRepositoryException - if an error occurs.

getServiceId

public String getServiceId()
                    throws AmetysRepositoryException

Description copied from interface: ZoneItem

Retrieves the service id.

Specified by:

getServiceId in interface ZoneItem

Returns:

the service id.

Throws:

AmetysRepositoryException - if an error occurs.

setServiceId

public void setServiceId(String serviceId)
                  throws AmetysRepositoryException

Description copied from interface: ModifiableZoneItem

Set the service id.

Specified by:

setServiceId in interface ModifiableZoneItem

Parameters:

serviceId - the service id.

Throws:

AmetysRepositoryException - if an error occurs.

getServiceParameters

public ModifiableModelAwareDataHolder getServiceParameters()
                                                    throws AmetysRepositoryException,
                                                           IllegalStateException

Get the service parameters

Specified by:

getServiceParameters in interface ModifiableZoneItem

Specified by:

getServiceParameters in interface ZoneItem

Returns:

the service parameters

Throws:

IllegalStateException - if the service referenced by this zone item does not exist

AmetysRepositoryException - if an error occurs.

_getServiceParametersRepositoryData

protected ModifiableRepositoryData _getServiceParametersRepositoryData()

Retrieves the ModifiableRepositoryData containing the service parameters of this zone item

Returns:

the ModifiableRepositoryData containing the service parameters of this zone item

getZoneItemParametersHolder

public ModifiableModelAwareDataHolder getZoneItemParametersHolder()
                                                           throws AmetysRepositoryException

Description copied from interface: ZoneItem

Get the view parameters

Specified by:

getZoneItemParametersHolder in interface ModifiableZoneItem

Specified by:

getZoneItemParametersHolder in interface ZoneItem

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.

getDataHolder

public ModifiableModelLessDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelLessDataAwareAmetysObject

Specified by:

getDataHolder in interface ModifiableModelLessDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
                      Locale locale)
               throws SAXException,
                      IOException,
                      UnknownTypeException,
                      NotUniqueTypeException

Description copied from interface: ModelLessDataHolder

Generates SAX events for data contained in this DataHolder

Specified by:

dataToSAX in interface ModelLessDataAwareAmetysObject

Specified by:

dataToSAX in interface ModelLessDataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

locale - The locale to use for localized data, such as MultilingualString. Can be null to generate SAX events for all existing Locales.

Throws:

SAXException - if an error occurs during the SAX events generation

IOException - if an error occurs while reading a value using the I/O API

UnknownTypeException - if there is no compatible type with the saxed value

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one) with the saxed value

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
                      String dataPath,
                      Locale locale)
               throws SAXException,
                      IOException

Description copied from interface: DataHolder

Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path

Specified by:

dataToSAX in interface DataAwareAmetysObject

Specified by:

dataToSAX in interface DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

locale - The locale to use for localized data, such as MultilingualString. Can be null to generate SAX events for all existing Locales.

Throws:

SAXException - if an error occurs during the SAX events generation

IOException - if an error occurs while reading a value using the I/O API

getMetadataHolder

public ModifiableCompositeMetadata getMetadataHolder()

Description copied from class: SimpleAmetysObject

Returns the root CompositeMetadata of this AmetysObject.

Specified by:

getMetadataHolder in interface MetadataAwareAmetysObject

Specified by:

getMetadataHolder in interface ModifiableMetadataAwareAmetysObject

Overrides:

getMetadataHolder in class SimpleAmetysObject<DefaultZoneItemFactory>

Returns:

the root CompositeMetadata of this AmetysObject

copyTo

public ModifiableZoneItem copyTo(ModifiableTraversableAmetysObject parent,
                                 String name,
                                 List<String> restrictTo)
                          throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object if it is not in the restriction list. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

restrictTo - A restrict list of CopiableAmetysObject authorized to be copied

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public ModifiableZoneItem copyTo(ModifiableTraversableAmetysObject parent,
                                 String name)
                          throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

canMoveTo

public boolean canMoveTo(AmetysObject newParent)
                  throws AmetysRepositoryException

Description copied from interface: MovableAmetysObject

Test if a move can be a success or if it is impossible (e.g. due to the implementation of the target)

Specified by:

canMoveTo in interface MovableAmetysObject

Parameters:

newParent - See moveTo.

Returns:

true if the move operation may succeed. If false is returned and you call moveTo anyway, you may encontered a RuntimeException (such as UnsupportedOperationException)

Throws:

AmetysRepositoryException - if an error occurs.

moveTo

public void moveTo(AmetysObject newParent,
                   boolean renameIfExist)
            throws AmetysRepositoryException,
                   RepositoryIntegrityViolationException

Description copied from interface: MovableAmetysObject

Move the current object as a new child of the given object. This node will be the last child. You should call canMoveTo to know if this is a supported operation.

Specified by:

moveTo in interface MovableAmetysObject

Parameters:

newParent - The new parent for the current object. Can not be null. Can not be a child of the current node. Must be a TraversableAmetyObject.

renameIfExist - true to rename moved page if a page with same name already exist

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if a page with the same name already exists.

orderBefore

public void orderBefore(AmetysObject siblingObject)
                 throws AmetysRepositoryException

Description copied from interface: MovableAmetysObject

Order a node before another sibling node (or as the last node)

Specified by:

orderBefore in interface MovableAmetysObject

Parameters:

siblingObject - The node that will be the next sibling node of the current node. Must have the same parent as the current node. Can be null to set the current node as the last node.

Throws:

AmetysRepositoryException - if an error occurs.

getZone

public Zone getZone()

Description copied from interface: ZoneItem

Get the parent zone.

Specified by:

getZone in interface ZoneItem

Returns:

the parent zone of the zone item. cannot be null

getContentViewParametersHolder

public ModifiableModelAwareDataHolder getContentViewParametersHolder(String contentViewName)
                                                              throws AmetysRepositoryException

Description copied from interface: ZoneItem

Get the content view parameters for a given view

Specified by:

getContentViewParametersHolder in interface ModifiableZoneItem

Specified by:

getContentViewParametersHolder in interface ZoneItem

Parameters:

contentViewName - the view name

Returns:

the content view parameters

Throws:

AmetysRepositoryException - if an error occurs.

getServiceViewParametersHolder

public ModifiableModelAwareDataHolder getServiceViewParametersHolder(String serviceViewName)
                                                              throws AmetysRepositoryException

Description copied from interface: ZoneItem

Get the service view parameters for a given view

Specified by:

getServiceViewParametersHolder in interface ModifiableZoneItem

Specified by:

getServiceViewParametersHolder in interface ZoneItem

Parameters:

serviceViewName - the view name

Returns:

the service view parameters

Throws:

AmetysRepositoryException - if an error occurs.