org.nuxeo.ecm.core.model

Class MockDocument

java.lang.Object

org.nuxeo.ecm.core.model.MockDocument

All Implemented Interfaces:

Document

public class MockDocument
extends Object
implements Document

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
boolean	checkedout
String	creator
Lock	lock
String	uuid

Constructor Summary

Constructors

Constructor and Description
MockDocument(String uuid, String creator)

Method Summary

Methods

Modifier and Type	Method and Description
Document	addChild(String name, String typeName) Creates a new child document of the given type.
boolean	addFacet(String facet) Adds a facet to this document.
Document	checkIn(String label, String description) Creates a new version.
void	checkOut()
void	followTransition(String transition) Follows a given life cycle transition.
Set<String>	getAllFacets() Gets the facets available on this document (from the type and the instance facets).
Collection<String>	getAllowedStateTransitions() Returns the allowed state transitions for this document.
Document	getBaseVersion() Gets the version to which a checked in document is linked.
String	getCheckinComment() Gets the version check in comment of this document if it's a version or a proxy.
Document	getChild(String name) Gets a child document given its name.
Iterator<Document>	getChildren() Gets an iterator over the children of the document.
List<String>	getChildrenIds() Gets a list of the children ids.
String[]	getFacets() Gets the facets defined on this document instance.
Document	getLastVersion() Gets the last version of this document.
String	getLifeCyclePolicy() Gets the life cycle policy of this document.
String	getLifeCycleState() Gets the life cycle state of this document.
Lock	getLock() Gets the lock if one set on this document.
String	getName() Gets the name of this document.
Document	getParent() Gets the parent document, or null if this is the root document.
String	getPath() Gets the path of this document.
Long	getPos() Gets the document's position in its containing folder (if ordered).
Serializable	getPropertyValue(String name) Gets a property value.
String	getRepositoryName() Gets the repository in which the document lives.
Session	getSession() Gets the session that owns this document.
Document	getSourceDocument() Gets the source for this document.
<T extends Serializable> T	getSystemProp(String name, Class<T> type) Gets a system property.
Document	getTargetDocument() Gets the document (version or live document) to which this proxy points.
DocumentType	getType() Gets the type of this document.
String	getUUID() Gets this document's UUID.
Document	getVersion(String label) Gets a version of this document, given its label.
Calendar	getVersionCreationDate() Gets the version creation date of this document if it's a version or a proxy.
String	getVersionLabel() Gets the version label.
List<Document>	getVersions() Gets the versions for this document.
String	getVersionSeriesId() Gets the version series id.
List<String>	getVersionsIds() Gets the list of version ids for this document.
Document	getWorkingCopy() Gets the working copy for this document.
boolean	hasChild(String name) Checks whether this document has a child of the given name.
boolean	hasChildren() Tests if the document has any children.
boolean	hasFacet(String facet) Checks whether this document has a given facet, either from its type or added on the instance.
boolean	isCheckedOut() Checks whether this document is checked out.
boolean	isFolder() Checks whether this document is a folder.
boolean	isLatestMajorVersion() Checks whether this document is the latest major version.
boolean	isLatestVersion() Checks whether this document is the latest version.
boolean	isMajorVersion() Checks whether this document is a major version.
boolean	isProxy() Checks whether or not this document is a proxy.
boolean	isReadOnly() Checks whether this document is readonly or not.
boolean	isVersion() Checks whether this document is a version document.
boolean	isVersionSeriesCheckedOut() Checks if there is a checked out working copy for the version series of this document.
void	orderBefore(String src, String dest) Orders the given source child before the destination child.
void	readDocumentPart(DocumentPart dp) Loads a DocumentPart from storage.
Map<String,Serializable>	readPrefetch(ComplexType complexType, Set<String> xpaths) Reads a set of prefetched fields.
void	remove() Removes this document and all its children, if any.
boolean	removeFacet(String facet) Removes a facet from this document.
Lock	removeLock(String owner) Removes a lock from this document.
void	restore(Document version) Replaces this document's content with the version specified.
void	setCurrentLifeCycleState(String state) Sets the life cycle state of this document.
void	setLifeCyclePolicy(String policy) Sets the life cycle policy of this document.
Lock	setLock(Lock lock) Sets a lock on this document.
void	setPropertyValue(String name, Serializable value) Sets a property value.
void	setReadOnly(boolean readonly) Sets this document as readonly or not.
void	setSystemProp(String name, Serializable value) Sets a system property.
void	setTargetDocument(Document target) Sets the document (version or live document) to which this proxy points.
void	writeDocumentPart(DocumentPart dp) Writes a DocumentPart to storage.

Methods inherited from class java.lang.Object

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

Field Detail

uuid

public String uuid

creator

public String creator

lock

public Lock lock

checkedout

public boolean checkedout

Constructor Detail

MockDocument

public MockDocument(String uuid,
            String creator)

Method Detail

getName

public String getName()

Description copied from interface: Document

Gets the name of this document.

Specified by:

getName in interface Document

Returns:

the document name

getPos

public Long getPos()

Description copied from interface: Document

Gets the document's position in its containing folder (if ordered).

Specified by:

getPos in interface Document

Returns:

the position

getUUID

public String getUUID()

Description copied from interface: Document

Gets this document's UUID.

Specified by:

getUUID in interface Document

Returns:

the document UUID

getSession

public Session getSession()

Description copied from interface: Document

Gets the session that owns this document.

Specified by:

getSession in interface Document

Returns:

the session

getType

public DocumentType getType()

Description copied from interface: Document

Gets the type of this document.

Specified by:

getType in interface Document

Returns:

the document type

getPath

public String getPath()
               throws DocumentException

Description copied from interface: Document

Gets the path of this document.

Specified by:

getPath in interface Document

Returns:

the path

Throws:

DocumentException

getRepositoryName

public String getRepositoryName()

Description copied from interface: Document

Gets the repository in which the document lives.

Specified by:

getRepositoryName in interface Document

Returns:

the repository name.

setLifeCyclePolicy

public void setLifeCyclePolicy(String policy)

Description copied from interface: Document

Sets the life cycle policy of this document.

Specified by:

setLifeCyclePolicy in interface Document

Parameters:

policy - the life cycle policy

setCurrentLifeCycleState

public void setCurrentLifeCycleState(String state)

Description copied from interface: Document

Sets the life cycle state of this document.

Specified by:

setCurrentLifeCycleState in interface Document

Parameters:

state - the life cycle state

followTransition

public void followTransition(String transition)

Description copied from interface: Document

Follows a given life cycle transition.

This will update the life cycle state of the document.

Specified by:

followTransition in interface Document

Parameters:

transition - the name of the transition to follow

getAllowedStateTransitions

public Collection<String> getAllowedStateTransitions()
                                              throws LifeCycleException

Description copied from interface: Document

Returns the allowed state transitions for this document.

Specified by:

getAllowedStateTransitions in interface Document

Returns:

a collection of state transitions

Throws:

LifeCycleException

getBaseVersion

public Document getBaseVersion()
                        throws DocumentException

Description copied from interface: Document

Gets the version to which a checked in document is linked.

Returns null for a checked out document or a version or a proxy.

Specified by:

getBaseVersion in interface Document

Returns:

the version, or null

Throws:

DocumentException

getLifeCycleState

public String getLifeCycleState()
                         throws LifeCycleException

Description copied from interface: Document

Gets the life cycle state of this document.

Specified by:

getLifeCycleState in interface Document

Returns:

the life cycle state

Throws:

LifeCycleException

getLifeCyclePolicy

public String getLifeCyclePolicy()
                          throws LifeCycleException

Description copied from interface: Document

Gets the life cycle policy of this document.

Specified by:

getLifeCyclePolicy in interface Document

Returns:

the life cycle policy

Throws:

LifeCycleException

getParent

public Document getParent()
                   throws DocumentException

Description copied from interface: Document

Gets the parent document, or null if this is the root document.

Specified by:

getParent in interface Document

Returns:

the parent document, or null

Throws:

DocumentException

getSystemProp

public <T extends Serializable> T getSystemProp(String name,
                                       Class<T> type)
                                     throws DocumentException

Description copied from interface: Document

Gets a system property.

Specified by:

getSystemProp in interface Document

Throws:

DocumentException

isFolder

public boolean isFolder()

Description copied from interface: Document

Checks whether this document is a folder.

Specified by:

isFolder in interface Document

Returns:

true if the document is a folder, false otherwise

isProxy

public boolean isProxy()

Description copied from interface: Document

Checks whether or not this document is a proxy.

Specified by:

isProxy in interface Document

Returns:

true if this document is a proxy, false otherwise

setReadOnly

public void setReadOnly(boolean readonly)

Description copied from interface: Document

Sets this document as readonly or not.

Specified by:

setReadOnly in interface Document

isReadOnly

public boolean isReadOnly()

Description copied from interface: Document

Checks whether this document is readonly or not.

Specified by:

isReadOnly in interface Document

remove

public void remove()
            throws DocumentException

Description copied from interface: Document

Removes this document and all its children, if any.

Specified by:

remove in interface Document

Throws:

DocumentException

setSystemProp

public void setSystemProp(String name,
                 Serializable value)
                   throws DocumentException

Description copied from interface: Document

Sets a system property.

Specified by:

setSystemProp in interface Document

Throws:

DocumentException

checkIn

public Document checkIn(String label,
               String description)
                 throws DocumentException

Description copied from interface: Document

Creates a new version.

Specified by:

checkIn in interface Document

Parameters:

label - the version label

description - the checkin comment

Returns:

the created version

Throws:

DocumentException

checkOut

public void checkOut()
              throws DocumentException

Specified by:

checkOut in interface Document

Throws:

DocumentException

getLastVersion

public Document getLastVersion()
                        throws DocumentException

Description copied from interface: Document

Gets the last version of this document.

Returns null if there is no version at all.

Specified by:

getLastVersion in interface Document

Returns:

the last version, or null if there is no version

Throws:

DocumentException

getSourceDocument

public Document getSourceDocument()
                           throws DocumentException

Description copied from interface: Document

Gets the source for this document.

For a version, it's the working copy.

For a proxy, it's the version the proxy points to.

Specified by:

getSourceDocument in interface Document

Returns:

the source document

Throws:

DocumentException

getVersionsIds

public List<String> getVersionsIds()
                            throws DocumentException

Description copied from interface: Document

Gets the list of version ids for this document.

Specified by:

getVersionsIds in interface Document

Returns:

the list of version ids

Throws:

DocumentException

getVersion

public Document getVersion(String label)
                    throws DocumentException

Description copied from interface: Document

Gets a version of this document, given its label.

Specified by:

getVersion in interface Document

Parameters:

label - the version label

Returns:

the version

Throws:

DocumentException

getVersions

public List<Document> getVersions()
                           throws DocumentException

Description copied from interface: Document

Gets the versions for this document.

Specified by:

getVersions in interface Document

Returns:

the versions of the document, or an empty list if there are no versions

Throws:

DocumentException

isCheckedOut

public boolean isCheckedOut()
                     throws DocumentException

Description copied from interface: Document

Checks whether this document is checked out.

Specified by:

isCheckedOut in interface Document

Returns:

true if the document is checked out, or false otherwise

Throws:

DocumentException

isVersion

public boolean isVersion()

Description copied from interface: Document

Checks whether this document is a version document.

Specified by:

isVersion in interface Document

Returns:

true if it's a version, false otherwise

getVersionSeriesId

public String getVersionSeriesId()
                          throws DocumentException

Description copied from interface: Document

Gets the version series id.

Specified by:

getVersionSeriesId in interface Document

Returns:

the version series id

Throws:

DocumentException

restore

public void restore(Document version)
             throws DocumentException

Description copied from interface: Document

Replaces this document's content with the version specified.

Specified by:

restore in interface Document

Parameters:

version - the version to replace with

Throws:

DocumentException

addChild

public Document addChild(String name,
                String typeName)
                  throws DocumentException

Description copied from interface: Document

Creates a new child document of the given type.

Throws an error if this document is not a folder.

Specified by:

addChild in interface Document

Parameters:

name - the name of the new child to create

typeName - the type of the child to create

Returns:

the newly created document

Throws:

DocumentException

getChild

public Document getChild(String name)
                  throws DocumentException

Description copied from interface: Document

Gets a child document given its name.

Throws NoSuchDocumentException if the document could not be found.

Specified by:

getChild in interface Document

Parameters:

name - the name of the child to retrieve

Returns:

the child if exists

Throws:

NoSuchDocumentException - if the child does not exist

DocumentException

getChildren

public Iterator<Document> getChildren()
                               throws DocumentException

Description copied from interface: Document

Gets an iterator over the children of the document.

Returns an empty iterator for non-folder documents.

Specified by:

getChildren in interface Document

Returns:

the children iterator

Throws:

DocumentException

getChildrenIds

public List<String> getChildrenIds()
                            throws DocumentException

Description copied from interface: Document

Gets a list of the children ids.

Returns an empty list for non-folder documents.

Specified by:

getChildrenIds in interface Document

Returns:

a list of children ids.

Throws:

DocumentException

hasChild

public boolean hasChild(String name)
                 throws DocumentException

Description copied from interface: Document

Checks whether this document has a child of the given name.

Returns false for non-folder documents.

Specified by:

hasChild in interface Document

Parameters:

name - the name of the child to check

Returns:

true if the child exists, false otherwise

Throws:

DocumentException

hasChildren

public boolean hasChildren()
                    throws DocumentException

Description copied from interface: Document

Tests if the document has any children.

Returns false for non-folder documents.

Specified by:

hasChildren in interface Document

Returns:

true if the document has children, false otherwise

Throws:

DocumentException

getPropertyValue

public Serializable getPropertyValue(String name)
                              throws DocumentException

Description copied from interface: Document

Gets a property value.

Specified by:

getPropertyValue in interface Document

Parameters:

name - the name of the property to get

Returns:

the property value or null if the property is not set

Throws:

DocumentException

setPropertyValue

public void setPropertyValue(String name,
                    Serializable value)
                      throws DocumentException

Description copied from interface: Document

Sets a property value.

Specified by:

setPropertyValue in interface Document

Parameters:

name - the name of the property to set

value - the value to set

Throws:

DocumentException

getLock

public Lock getLock()
             throws DocumentException

Description copied from interface: Document

Gets the lock if one set on this document.

Specified by:

getLock in interface Document

Returns:

the lock, or null if no lock is set

Throws:

DocumentException

setLock

public Lock setLock(Lock lock)
             throws DocumentException

Description copied from interface: Document

Sets a lock on this document.

Specified by:

setLock in interface Document

Parameters:

lock - the lock to set

Returns:

null if locking succeeded, or the existing lock if locking failed

Throws:

DocumentException

removeLock

public Lock removeLock(String owner)
                throws DocumentException

Description copied from interface: Document

Removes a lock from this document.

Specified by:

removeLock in interface Document

Returns:

null if there was no lock or if removal succeeded, or a lock if it blocks removal due to owner mismatch

Throws:

DocumentException

readDocumentPart

public void readDocumentPart(DocumentPart dp)

Description copied from interface: Document

Loads a DocumentPart from storage.

Reading data is done by DocumentPart because of per-proxy schemas.

Specified by:

readDocumentPart in interface Document

readPrefetch

public Map<String,Serializable> readPrefetch(ComplexType complexType,
                                    Set<String> xpaths)

Description copied from interface: Document

Reads a set of prefetched fields.

Reading data is done by ComplexType because of per-proxy schemas.

Specified by:

readPrefetch in interface Document

writeDocumentPart

public void writeDocumentPart(DocumentPart dp)

Description copied from interface: Document

Writes a DocumentPart to storage.

Writing data is done by DocumentPart because of per-proxy schemas.

Specified by:

writeDocumentPart in interface Document

orderBefore

public void orderBefore(String src,
               String dest)
                 throws DocumentException

Description copied from interface: Document

Orders the given source child before the destination child.

Both source and destination must be names that point to child documents of this document. The source document will be placed before the destination one. If destination is null, the source document will be appended at the end of the children list.

Specified by:

orderBefore in interface Document

Parameters:

src - the document to move

dest - the document before which to place the source document

Throws:

DocumentException - if this document is not an orderable folder

getVersionCreationDate

public Calendar getVersionCreationDate()
                                throws DocumentException

Description copied from interface: Document

Gets the version creation date of this document if it's a version or a proxy.

Specified by:

getVersionCreationDate in interface Document

Returns:

the version creation date, or null if it's not a version or a proxy

Throws:

DocumentException

getVersionLabel

public String getVersionLabel()
                       throws DocumentException

Description copied from interface: Document

Gets the version label.

Specified by:

getVersionLabel in interface Document

Returns:

the version label

Throws:

DocumentException

isLatestVersion

public boolean isLatestVersion()
                        throws DocumentException

Description copied from interface: Document

Checks whether this document is the latest version.

Specified by:

isLatestVersion in interface Document

Returns:

true if this is the latest version, or false otherwise

Throws:

DocumentException

isMajorVersion

public boolean isMajorVersion()
                       throws DocumentException

Description copied from interface: Document

Checks whether this document is a major version.

Specified by:

isMajorVersion in interface Document

Returns:

true if this is a major version, or false otherwise

Throws:

DocumentException

isLatestMajorVersion

public boolean isLatestMajorVersion()
                             throws DocumentException

Description copied from interface: Document

Checks whether this document is the latest major version.

Specified by:

isLatestMajorVersion in interface Document

Returns:

true if this is the latest major version, or false otherwise

Throws:

DocumentException

isVersionSeriesCheckedOut

public boolean isVersionSeriesCheckedOut()
                                  throws DocumentException

Description copied from interface: Document

Checks if there is a checked out working copy for the version series of this document.

Specified by:

isVersionSeriesCheckedOut in interface Document

Returns:

true if there is a checked out working copy

Throws:

DocumentException

getWorkingCopy

public Document getWorkingCopy()
                        throws DocumentException

Description copied from interface: Document

Gets the working copy for this document.

Specified by:

getWorkingCopy in interface Document

Returns:

the working copy

Throws:

DocumentException

getCheckinComment

public String getCheckinComment()
                         throws DocumentException

Description copied from interface: Document

Gets the version check in comment of this document if it's a version or a proxy.

Specified by:

getCheckinComment in interface Document

Returns:

the check in comment, or null if it's not a version or a proxy

Throws:

DocumentException

getAllFacets

public Set<String> getAllFacets()

Description copied from interface: Document

Gets the facets available on this document (from the type and the instance facets).

Specified by:

getAllFacets in interface Document

Returns:

the facets

getFacets

public String[] getFacets()

Description copied from interface: Document

Gets the facets defined on this document instance. The type facets are not returned.

Specified by:

getFacets in interface Document

Returns:

the facets

hasFacet

public boolean hasFacet(String facet)

Description copied from interface: Document

Checks whether this document has a given facet, either from its type or added on the instance.

Specified by:

hasFacet in interface Document

Parameters:

facet - the facet name

Returns:

true if the document has the facet

addFacet

public boolean addFacet(String facet)
                 throws DocumentException

Description copied from interface: Document

Adds a facet to this document.

Does nothing if the facet was already present on the document.

Specified by:

addFacet in interface Document

Parameters:

facet - the facet name

Returns:

true if the facet was added, or false if it is already present

Throws:

DocumentException - if the facet does not exist

removeFacet

public boolean removeFacet(String facet)
                    throws DocumentException

Description copied from interface: Document

Removes a facet from this document.

It's not possible to remove a facet coming from the document type.

Specified by:

removeFacet in interface Document

Parameters:

facet - the facet name

Returns:

true if the facet was removed, or false if it isn't present or is present on the type or does not exit

Throws:

DocumentException

getTargetDocument

public Document getTargetDocument()

Description copied from interface: Document

Gets the document (version or live document) to which this proxy points.

Specified by:

getTargetDocument in interface Document

setTargetDocument

public void setTargetDocument(Document target)
                       throws DocumentException

Description copied from interface: Document

Sets the document (version or live document) to which this proxy points.

Specified by:

setTargetDocument in interface Document

Throws:

DocumentException