org.ametys.web.repository.content.jcr

Class DefaultWebContent<F extends DefaultWebContentFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

org.ametys.plugins.repository.jcr.DefaultAmetysObject<F>

org.ametys.cms.repository.DefaultContent<F>

org.ametys.web.repository.content.jcr.DefaultWebContent<F>

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

Content, TagAwareAmetysObject, ACLAmetysObject, AmetysObject, CopiableAmetysObject, DublinCoreAwareAmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject, MetadataAndVersionAwareAmetysObject, ModifiableMetadataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject, WebContent, SiteAwareAmetysObject

Direct Known Subclasses:

DefaultSharedContent, ModifiableDefaultWebContent

public class DefaultWebContent<F extends DefaultWebContentFactory>
extends DefaultContent<F>
implements WebContent

DefaultContent which is TagAwareAmetysObject.

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA_SITE Constants for site Metadata.

Fields inherited from class org.ametys.cms.repository.DefaultContent

ATTACHMENTS_NODE_NAME, METADATA_CONTENTTYPE, METADATA_CONTRIBUTOR, METADATA_CREATION, METADATA_CREATOR, METADATA_LANGUAGE, METADATA_LAST_MAJORVALIDATION, METADATA_LAST_VALIDATION, METADATA_MIXINCONTENTTYPES, METADATA_MODIFIED, METADATA_OUTGOING_REFERENCE_PROPERTY, METADATA_OUTGOING_REFERENCES, METADATA_OUTGOING_REFERENCES_PATH_PROPERTY, METADATA_ROOT_OUTGOING_REFERENCES, METADATA_TITLE

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

PROTECTED_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
DefaultWebContent(Node node, String parentPath, F factory) Creates a DefaultWebContent.

Method Summary

Modifier and Type	Method and Description
ModifiableContent	copyTo(ModifiableTraversableAmetysObject parent, String name) Copy the current AmetysObject to the given object.
<A extends AmetysObject> A	createChild(String name, String type) Creates a child below current object.
<A extends AmetysObject> A	getChild(String path) Retrieves a given child from its relative path.
<A extends AmetysObject> AmetysObjectIterable<A>	getChildren() Retrieves children of the current object.
Collection<Page>	getReferencingPages() Returns all pages referencing this Content.
Collection<ZoneItem>	getReferencingZoneItems() Returns all zone items referencing this Content.
ResourceCollection	getRootAttachments() Retrieves the attachments root node
Site	getSite() Returns this object's site.
String	getSiteName() Returns this object's site name.
boolean	hasChild(String name) Tests if this Object has at least one child with the given name.

Methods inherited from class org.ametys.cms.repository.DefaultContent

copyTo, copyTo, copyTo, getCreationDate, getCreator, getDCContributor, getDCCoverage, getDCCreator, getDCDate, getDCDescription, getDCFormat, getDCIdentifier, getDCLanguage, getDCPublisher, getDCRelation, getDCRights, getDCSource, getDCSubject, getDCTitle, getDCType, getLanguage, getLastContributor, getLastMajorValidationDate, getLastModified, getLastValidationDate, getMixinTypes, getOutgoingReferences, getReferencingContents, getTags, getTitle, getTypes

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

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, addLabel, checkpoint, copyNode, getAllLabels, getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getAllRevisions, getBaseNode, getBaseVersion, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers, getLabels, getLabels, getNode, getRevision, getRevisionTimestamp, getRevisionTimestamp, getUnversionedMetadataHolder, getVersionHistory, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers, removeLabel, restoreFromLabel, restoreFromNode, restoreFromRevision, switchToLabel, switchToRevision

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

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, 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.cms.repository.Content

getCreationDate, getCreator, getLanguage, getLastContributor, getLastMajorValidationDate, getLastModified, getLastValidationDate, getMixinTypes, getOutgoingReferences, getReferencingContents, getTitle, getTypes

Methods inherited from interface org.ametys.plugins.repository.metadata.MetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.dublincore.DublinCoreAwareAmetysObject

getDCContributor, getDCCoverage, getDCCreator, getDCDate, getDCDescription, getDCFormat, getDCIdentifier, getDCLanguage, getDCPublisher, getDCRelation, getDCRights, getDCSource, getDCSubject, getDCTitle, getDCType

Methods inherited from interface org.ametys.cms.repository.TagAwareAmetysObject

getTags

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

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

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

getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers

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

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

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

getChildAt, getChildPosition

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

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

needsSave, rename, revertChanges, saveChanges

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

remove

Field Detail

METADATA_SITE

public static final String METADATA_SITE

Constants for site Metadata.

See Also:

Constant Field Values

Constructor Detail

DefaultWebContent

public DefaultWebContent(Node node,
                         String parentPath,
                         F factory)

Creates a DefaultWebContent.

Parameters:

node - the node backing this DefaultWebContent.

parentPath - the parent path in the Ametys hierarchy.

factory - the DefaultWebContentFactory which creates the AmetysObject.

Method Detail

copyTo

public ModifiableContent 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

Overrides:

copyTo in class DefaultContent<F extends DefaultWebContentFactory>

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.

getReferencingPages

public Collection<Page> getReferencingPages()

Description copied from interface: WebContent

Returns all pages referencing this Content.

Specified by:

getReferencingPages in interface WebContent

Returns:

all pages referencing this Content.

getReferencingZoneItems

public Collection<ZoneItem> getReferencingZoneItems()

Description copied from interface: WebContent

Returns all zone items referencing this Content.

Specified by:

getReferencingZoneItems in interface WebContent

Returns:

all zone items referencing this Content.

getRootAttachments

public ResourceCollection getRootAttachments()
                                      throws AmetysRepositoryException

Description copied from interface: Content

Retrieves the attachments root node

Specified by:

getRootAttachments in interface Content

Specified by:

getRootAttachments in interface WebContent

Overrides:

getRootAttachments in class DefaultContent<F extends DefaultWebContentFactory>

Returns:

The attachments root node, or null if the content is working on an (unmodifiable) old version and the attachments root is missing.

Throws:

AmetysRepositoryException - if an error occurs.

getSite

public Site getSite()

Description copied from interface: SiteAwareAmetysObject

Returns this object's site.

Specified by:

getSite in interface SiteAwareAmetysObject

Returns:

this object's site

getSiteName

public String getSiteName()

Description copied from interface: SiteAwareAmetysObject

Returns this object's site name.

Specified by:

getSiteName in interface SiteAwareAmetysObject

Returns:

this object's site name.

hasChild

public boolean hasChild(String name)
                 throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Tests if this Object has at least one child with the given name.

Specified by:

hasChild in interface TraversableAmetysObject

Overrides:

hasChild in class DefaultContent<F extends DefaultWebContentFactory>

Parameters:

name - the name to test. Cannot be null nor empty nor begin with a '/' and it cannot contain '/'.

Returns:

true if the named child exists, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

createChild

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

Description copied from interface: ModifiableTraversableAmetysObject

Creates a child below current object.

Specified by:

createChild in interface ModifiableTraversableAmetysObject

Overrides:

createChild in class DefaultContent<F extends DefaultWebContentFactory>

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

name - the name of the child, position ([n]) are not supported for same name sibling, the child will be added at the end of the children list.

type - the type of the object.

Returns:

the new object created.

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if an object with the same name already exists and same name siblings is not allowed.

getChild

public <A extends AmetysObject> A getChild(String path)
                                    throws AmetysRepositoryException,
                                           UnknownAmetysObjectException

Description copied from interface: TraversableAmetysObject

Retrieves a given child from its relative path. The path cannot be null, empty nor begin with a '/'.

Specified by:

getChild in interface TraversableAmetysObject

Overrides:

getChild in class DefaultContent<F extends DefaultWebContentFactory>

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

path - the path of the child which can contains a position with. [n] if same name sibling is allowed.

Returns:

the child found.

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if the object does not exist.

getChildren

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

Description copied from interface: TraversableAmetysObject

Retrieves children of the current object.

Specified by:

getChildren in interface TraversableAmetysObject

Overrides:

getChildren in class DefaultContent<F extends DefaultWebContentFactory>

Type Parameters:

A - the actual type of AmetysObjects.

Returns:

the children or an empty AmetysObjectIterable.

Throws:

AmetysRepositoryException - if an error occurs.