org.nuxeo.ecm.core.storage.sql.coremodel

Class SQLDocumentVersion

java.lang.Object

org.nuxeo.ecm.core.storage.BaseDocument<Node>

org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocumentLive

org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocumentVersion

All Implemented Interfaces:

Document, SQLDocument

public class SQLDocumentVersion
extends SQLDocumentLive

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQLDocumentVersion.VersionNotModifiableException

Nested classes/interfaces inherited from class org.nuxeo.ecm.core.storage.BaseDocument

BaseDocument.BlobWriteContext<T extends StateAccessor>, BaseDocument.BlobWriteInfo<T extends StateAccessor>, BaseDocument.StateBlobAccessor, BaseDocument.Visit

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.model.Document

Document.BlobAccessor, Document.WriteContext

Field Summary

Fields inherited from class org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocumentLive

node, proxySchemas, readonly, session, systemPropNameMap, type

Fields inherited from class org.nuxeo.ecm.core.storage.BaseDocument

BLOB_DATA, BLOB_DIGEST, BLOB_ENCODING, BLOB_LENGTH, BLOB_MIME_TYPE, BLOB_NAME, DC_ISSUED, DC_MODIFIED, DC_PREFIX, EMPTY_STRING_ARRAY, FULLTEXT_BINARYTEXT_PROP, FULLTEXT_JOBID_PROP, FULLTEXT_SIMPLETEXT_PROP, LOCK_CREATED_PROP, LOCK_OWNER_PROP, MISC_LIFECYCLE_STATE_PROP, NO_DIRTY, NON_CANONICAL_INDEX, RELATED_TEXT, RELATED_TEXT_ID, RELATED_TEXT_RESOURCES, TOKEN_SEP, VERSION_WRITABLE_PROPS

Fields inherited from interface org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocument

BINARY_TEXT_SYS_PROP, FULLTEXT_JOBID_SYS_PROP, SIMPLE_TEXT_SYS_PROP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SQLDocumentVersion(Node node, ComplexType type, SQLSession session, boolean readonly)

Method Summary

Modifier and Type	Method and Description
Document	addChild(String name, String typeName) Creates a new child document of the given type.
Document	checkIn(String label, String description) Creates a new version.
void	checkOut()
boolean	equals(Object other)
Document	getBaseVersion() Gets the version to which a checked in document is linked.
Document	getChild(String name) Gets a child document given its name.
List<Document>	getChildren() Gets the children of the document.
List<String>	getChildrenIds() Gets a list of the children ids.
Document	getParent() Gets the parent document, or null if this is the root document.
String	getPath() Gets the path of this document.
Document	getSourceDocument() Gets the source for this document.
Document	getVersion(String label) Gets a version of this document, given its label.
String	getVersionSeriesId() Gets the version series id.
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.
int	hashCode()
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.
protected boolean	isReadOnlyProperty(String name)
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	restore(Document version) Replaces this document's content with the version specified.
void	setPropertyValue(String name, Serializable value) Sets a simple property value.

Methods inherited from class org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocumentLive

addFacet, followTransition, getAllFacets, getAllowedStateTransitions, getChangeToken, getCheckinComment, getChild, getChildAsList, getChildForWrite, getDocumentLock, getFacets, getLastVersion, getLifeCyclePolicy, getLifeCycleState, getName, getNode, getPos, getPropertyValue, getProxySchemas, getRepositoryName, getSession, getSystemProp, getTargetDocument, getType, getUUID, getValue, getVersionCreationDate, getVersionLabel, getVersions, getVersionsIds, hasFacet, internalName, isProxy, isReadOnly, isRetentionActive, markUserChange, readDocumentPart, readPrefetch, remove, removeDocumentLock, removeFacet, setCurrentLifeCycleState, setDocumentLock, setLifeCyclePolicy, setReadOnly, setRetentionActive, setSystemProp, setTargetDocument, setValue, toString, updateList, updateList, validateUserVisibleChangeToken, visitBlobs, writeDocumentPart

Methods inherited from class org.nuxeo.ecm.core.storage.BaseDocument

buildUserVisibleChangeToken, canonicalXPath, checkReadOnlyIgnoredWrite, clearDirtyFlags, getBlobInfo, getLegacyChangeToken, getLock, getTopLevelSchema, getValueBlob, getValueComplex, getValueField, getValueObject, getWriteContext, isVersionWritableProperty, readComplexProperty, readPrefetch, readPrefetch, readPrefetchField, removeLock, setBlobInfo, setLock, setValueBlob, setValueComplex, setValueField, setValueObject, typedArray, updateChangeToken, validateLegacyChangeToken, validateUserVisibleChangeToken, visitBlobs, writeComplexProperty, writeComplexProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.model.Document

getLock, getWriteContext, removeLock, setLock

Constructor Detail

SQLDocumentVersion

protected SQLDocumentVersion(Node node,
                             ComplexType type,
                             SQLSession session,
                             boolean readonly)

Method Detail

isVersion

public boolean isVersion()

Description copied from interface: Document

Checks whether this document is a version document.

Specified by:

isVersion in interface Document

Overrides:

isVersion in class SQLDocumentLive

Returns:

true if it's a version, false otherwise

isCheckedOut

public boolean isCheckedOut()

Description copied from interface: Document

Checks whether this document is checked out.

Specified by:

isCheckedOut in interface Document

Overrides:

isCheckedOut in class SQLDocumentLive

Returns:

true if the document is checked out, or false otherwise

isVersionSeriesCheckedOut

public boolean isVersionSeriesCheckedOut()

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

Overrides:

isVersionSeriesCheckedOut in class SQLDocumentLive

Returns:

true if there is a checked out working copy

isMajorVersion

public boolean isMajorVersion()

Description copied from interface: Document

Checks whether this document is a major version.

Specified by:

isMajorVersion in interface Document

Overrides:

isMajorVersion in class SQLDocumentLive

Returns:

true if this is a major version, or false otherwise

isLatestVersion

public boolean isLatestVersion()

Description copied from interface: Document

Checks whether this document is the latest version.

Specified by:

isLatestVersion in interface Document

Overrides:

isLatestVersion in class SQLDocumentLive

Returns:

true if this is the latest version, or false otherwise

isLatestMajorVersion

public boolean isLatestMajorVersion()

Description copied from interface: Document

Checks whether this document is the latest major version.

Specified by:

isLatestMajorVersion in interface Document

Overrides:

isLatestMajorVersion in class SQLDocumentLive

Returns:

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

getWorkingCopy

public Document getWorkingCopy()

Description copied from interface: Document

Gets the working copy for this document.

Specified by:

getWorkingCopy in interface Document

Overrides:

getWorkingCopy in class SQLDocumentLive

Returns:

the working copy

getBaseVersion

public Document getBaseVersion()

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

Overrides:

getBaseVersion in class SQLDocumentLive

Returns:

the version, or null

getVersionSeriesId

public String getVersionSeriesId()

Description copied from interface: Document

Gets the version series id.

Specified by:

getVersionSeriesId in interface Document

Overrides:

getVersionSeriesId in class SQLDocumentLive

Returns:

the version series id

getSourceDocument

public Document getSourceDocument()

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

Overrides:

getSourceDocument in class SQLDocumentLive

Returns:

the source document

getPath

public String getPath()

Description copied from interface: Document

Gets the path of this document.

Specified by:

getPath in interface Document

Overrides:

getPath in class SQLDocumentLive

Returns:

the path

getParent

public Document getParent()

Description copied from interface: Document

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

Specified by:

getParent in interface Document

Overrides:

getParent in class SQLDocumentLive

Returns:

the parent document, or null

isFolder

public boolean isFolder()

Description copied from interface: Document

Checks whether this document is a folder.

Specified by:

isFolder in interface Document

Overrides:

isFolder in class SQLDocumentLive

Returns:

true if the document is a folder, false otherwise

orderBefore

public void orderBefore(String src,
                        String dest)

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

Overrides:

orderBefore in class SQLDocumentLive

Parameters:

src - the document to move

dest - the document before which to place the source document

addChild

public Document addChild(String name,
                         String typeName)

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

Overrides:

addChild in class SQLDocumentLive

Parameters:

name - the name of the new child to create

typeName - the type of the child to create

Returns:

the newly created document

getChild

public Document getChild(String name)

Description copied from interface: Document

Gets a child document given its name.

Throws DocumentNotFoundException if the document could not be found.

Specified by:

getChild in interface Document

Overrides:

getChild in class SQLDocumentLive

Parameters:

name - the name of the child to retrieve

Returns:

the child if exists

getChildren

public List<Document> getChildren()

Description copied from interface: Document

Gets the children of the document.

Returns an empty list for non-folder documents.

Specified by:

getChildren in interface Document

Overrides:

getChildren in class SQLDocumentLive

Returns:

the children

getChildrenIds

public List<String> getChildrenIds()

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

Overrides:

getChildrenIds in class SQLDocumentLive

Returns:

a list of children ids.

hasChild

public boolean hasChild(String name)

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

Overrides:

hasChild in class SQLDocumentLive

Parameters:

name - the name of the child to check

Returns:

true if the child exists, false otherwise

hasChildren

public boolean hasChildren()

Description copied from interface: Document

Tests if the document has any children.

Returns false for non-folder documents.

Specified by:

hasChildren in interface Document

Overrides:

hasChildren in class SQLDocumentLive

Returns:

true if the document has children, false otherwise

checkIn

public Document checkIn(String label,
                        String description)

Description copied from interface: Document

Creates a new version.

Specified by:

checkIn in interface Document

Overrides:

checkIn in class SQLDocumentLive

Parameters:

label - the version label

description - the checkin comment

Returns:

the created version

checkOut

public void checkOut()

Specified by:

checkOut in interface Document

Overrides:

checkOut in class SQLDocumentLive

restore

public void restore(Document version)

Description copied from interface: Document

Replaces this document's content with the version specified.

Specified by:

restore in interface Document

Overrides:

restore in class SQLDocumentLive

Parameters:

version - the version to replace with

getVersion

public Document getVersion(String label)

Description copied from interface: Document

Gets a version of this document, given its label.

Specified by:

getVersion in interface Document

Overrides:

getVersion in class SQLDocumentLive

Parameters:

label - the version label

Returns:

the version

setPropertyValue

public void setPropertyValue(String name,
                             Serializable value)

Description copied from interface: Document

Sets a simple property value.

For more generic properties described by an xpath, use Document.setValue(java.lang.String, java.lang.Object) instead.

Specified by:

setPropertyValue in interface Document

Overrides:

setPropertyValue in class SQLDocumentLive

Parameters:

name - the name of the property to set

value - the value to set

See Also:

Document.setValue(java.lang.String, java.lang.Object)

isReadOnlyProperty

protected boolean isReadOnlyProperty(String name)

equals

public boolean equals(Object other)

Overrides:

equals in class SQLDocumentLive

hashCode

public int hashCode()

Overrides:

hashCode in class SQLDocumentLive