Package org.nuxeo.ecm.automation.core.scripting

Class DocumentWrapper

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Serializable>

org.nuxeo.ecm.automation.core.scripting.DocumentWrapper

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Serializable>

public class DocumentWrapper
extends HashMap<String,Serializable>

Wrap a DocumentModel to expose in a pretty way more information to mvel scripts.

Author:

Bogdan Stefanescu

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected final DocumentModel	doc
protected final CoreSession	session

Constructor Summary

Constructors

Constructor	Description
DocumentWrapper(CoreSession session, DocumentModel doc)

Method Summary

Modifier and Type	Method	Description
boolean	addFacet(String facet)
void	clear()
boolean	containsKey(Object key)	property map implementation
boolean	containsValue(Object value)	The behavior of this method was changed -> it is checking if an xpath has a value attached.
Set<Map.Entry<String,Serializable>>	entrySet()
Serializable	get(Object key)
String	getDescription()
DocumentModel	getDoc()
DocumentType	getDocumentType()
DocumentWrapper	getDomain()
Set<String>	getFacets()
String	getId()
String	getLifeCycle()
String	getName()
DocumentWrapper	getParent()
DocumentWrapper	getParent(String type)
String	getPath()
Serializable	getProperty(String key)
Serializable	getPropertyValue(String key)
DocumentRef	getRef()
String[]	getSchemas()
CoreSession	getSession()
String	getTitle()
String	getType()
String	getVersionLabel()
DocumentWrapper	getWorkspace()
boolean	hasFacet(String facet)
boolean	hasSchema(String schema)
boolean	isDownloadable()
boolean	isEmpty()
boolean	isFolder()
boolean	isImmutable()
boolean	isLocked()
boolean	isProxy()
boolean	isTrashed()
boolean	isVersion()
boolean	isVersionable()
Set<String>	keySet()
Serializable	put(String key, Serializable value)
void	putAll(Map<? extends String,? extends Serializable> m)
Serializable	remove(Object key)
boolean	removeFacet(String facet)
String	resolvePath(String relative)
DocumentRef	resolvePathAsRef(String relative)
void	setProperty(String key, Serializable value)
void	setPropertyValue(String key, Serializable value)
int	size()
Collection<Serializable>	values()

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Details

session

protected final CoreSession session

doc

protected final DocumentModel doc

Constructor Details

DocumentWrapper

public DocumentWrapper(CoreSession session,
 DocumentModel doc)

Method Details

getDoc

public DocumentModel getDoc()

getSession

public CoreSession getSession()

getParent

public DocumentWrapper getParent()

getParent

public DocumentWrapper getParent(String type)

getWorkspace

public DocumentWrapper getWorkspace()

getDomain

public DocumentWrapper getDomain()

getTitle

public String getTitle()

getPath

public String getPath()

resolvePath

public String resolvePath(String relative)

getRef

public DocumentRef getRef()

Returns:

the document ref

Since:

5.6

resolvePathAsRef

public DocumentRef resolvePathAsRef(String relative)

getDescription

public String getDescription()

hasFacet

public boolean hasFacet(String facet)

hasSchema

public boolean hasSchema(String schema)

addFacet

public boolean addFacet(String facet)

removeFacet

public boolean removeFacet(String facet)

getType

public String getType()

getDocumentType

public DocumentType getDocumentType()

getLifeCycle

public String getLifeCycle()

isLocked

public boolean isLocked()

isFolder

public boolean isFolder()

isImmutable

public boolean isImmutable()

isProxy

public boolean isProxy()

isVersion

public boolean isVersion()

isDownloadable

public boolean isDownloadable()

isVersionable

public boolean isVersionable()

isTrashed

public boolean isTrashed()

Since:

2023.0

getId

public String getId()

getName

public String getName()

getSchemas

public String[] getSchemas()

getFacets

public Set<String> getFacets()

getProperty

public Serializable getProperty(String key)

getPropertyValue

public Serializable getPropertyValue(String key)

Since:

5.7.3 Alias for #getProperty.

setProperty

public void setProperty(String key,
 Serializable value)

setPropertyValue

public void setPropertyValue(String key,
 Serializable value)

Since:

5.7.3 Alias for #setProperty.

getVersionLabel

public String getVersionLabel()

containsKey

public boolean containsKey(Object key)

property map implementation

Specified by:

containsKey in interface Map<String,Serializable>

Overrides:

containsKey in class HashMap<String,Serializable>

containsValue

public boolean containsValue(Object value)

The behavior of this method was changed -> it is checking if an xpath has a value attached.

Specified by:

containsValue in interface Map<String,Serializable>

Overrides:

containsValue in class HashMap<String,Serializable>

get

public Serializable get(Object key)

Specified by:

get in interface Map<String,Serializable>

Overrides:

get in class HashMap<String,Serializable>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Serializable>

Overrides:

isEmpty in class HashMap<String,Serializable>

size

public int size()

Specified by:

size in interface Map<String,Serializable>

Overrides:

size in class HashMap<String,Serializable>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Serializable>

Overrides:

keySet in class HashMap<String,Serializable>

values

public Collection<Serializable> values()

Specified by:

values in interface Map<String,Serializable>

Overrides:

values in class HashMap<String,Serializable>

entrySet

public Set<Map.Entry<String,Serializable>> entrySet()

Specified by:

entrySet in interface Map<String,Serializable>

Overrides:

entrySet in class HashMap<String,Serializable>

put

public Serializable put(String key,
 Serializable value)

Specified by:

put in interface Map<String,Serializable>

Overrides:

put in class HashMap<String,Serializable>

putAll

public void putAll(Map<? extends String,? extends Serializable> m)

Specified by:

putAll in interface Map<String,Serializable>

Overrides:

putAll in class HashMap<String,Serializable>

remove

public Serializable remove(Object key)

Specified by:

remove in interface Map<String,Serializable>

Overrides:

remove in class HashMap<String,Serializable>

clear

public void clear()

Specified by:

clear in interface Map<String,Serializable>

Overrides:

clear in class HashMap<String,Serializable>