Package org.ametys.plugins.repository.model

Class RepositoryDataContext

java.lang.Object

org.ametys.runtime.model.type.DataContext

org.ametys.plugins.repository.model.RepositoryDataContext

Direct Known Subclasses:

CMSDataContext

public class RepositoryDataContext
extends DataContext

Object that gives some context for repository data manipulation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RepositoryDataContext()	Creates a new instance of a RepositoryDataContext
protected	RepositoryDataContext(DataContext context)	Creates a new instance of a RepositoryDataContext from another DataContext

Method Summary

Modifier and Type	Method	Description
protected <T extends DataAwareAmetysObject> Optional<T>	_getRootObject()	Retrieves the object from which the full data path is computed
protected <T extends RepositoryDataContext> T	_withRootObject(DataAwareAmetysObject rootObject)	Set the object from which the full data path is computed
RepositoryDataContext	cloneContext()	Creates a new instance of a RepositoryDataContext, with the current context values
boolean	copyExternalMetadata()	Check if the external metadata (alternative and status) should be copied
Set<String>	getExternalizableData()	Retrieves the externalizable data
<T extends DataAwareAmetysObject> Optional<T>	getObject()	Retrieves the object from which the data path is computed
Optional<String>	getObjectId()	Retrieves the identifier of the object
Optional<String>	getRootObjectId()	Retrieves the identifier of the root object
boolean	isDataExternalizable()	Check if the current data is externalizable
static RepositoryDataContext	newInstance()	Creates a new instance of a RepositoryDataContext
static RepositoryDataContext	newInstance(DataContext context)	Creates a new instance of a RepositoryDataContext from another DataContext.
<T extends RepositoryDataContext> T	withExternalizableData(Set<String> externalizableData)	Sets the externalizable data
<T extends RepositoryDataContext> T	withExternalMetadataInCopy(boolean copyExternalMetadata)	Set to true to copy the external metadata (alternative and status) (default to false)
<T extends RepositoryDataContext> T	withObject(DataAwareAmetysObject object)	Set the object from which the data path is computed

Methods inherited from class org.ametys.runtime.model.type.DataContext

addSegmentToDataPath, addSuffixToLastSegment, getDataPath, getDataPathLastSegment, getFullDataPath, getLocale, getModelItem, getViewItem, renderDisabledValues, renderEmptyValues, withDataPath, withDisabledValues, withEmptyValues, withFullDataPath, withLocale, withModelItem, withViewItem

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryDataContext

protected RepositoryDataContext()

Creates a new instance of a RepositoryDataContext

RepositoryDataContext

protected RepositoryDataContext(DataContext context)

Creates a new instance of a RepositoryDataContext from another DataContext

Parameters:

context - the data context to copy

Method Details

newInstance

public static RepositoryDataContext newInstance()

Creates a new instance of a RepositoryDataContext

Returns:

the created instance

newInstance

public static RepositoryDataContext newInstance(DataContext context)

Creates a new instance of a RepositoryDataContext from another DataContext. It can be the same implementation or another one, but it will be casted to the current implementation.

Parameters:

context - the data context to copy

Returns:

the created instance

cloneContext

public RepositoryDataContext cloneContext()

Creates a new instance of a RepositoryDataContext, with the current context values

Overrides:

cloneContext in class DataContext

Returns:

the created instance

getObject

public <T extends DataAwareAmetysObject>
Optional<T> getObject()

Retrieves the object from which the data path is computed

Type Parameters:

T - Type of the object

Returns:

the object

getObjectId

public Optional<String> getObjectId()

Retrieves the identifier of the object

Returns:

the object's identifier

withObject

public <T extends RepositoryDataContext> T withObject(DataAwareAmetysObject object)

Set the object from which the data path is computed

Type Parameters:

T - the type of the retrieved DataContext

Parameters:

object - the object to set

Returns:

the current DataContext

_getRootObject

protected <T extends DataAwareAmetysObject>
Optional<T> _getRootObject()

Retrieves the object from which the full data path is computed

Type Parameters:

T - Type of the root object

Returns:

the root object

getRootObjectId

public Optional<String> getRootObjectId()

Retrieves the identifier of the root object

Returns:

the root object's identifier

_withRootObject

protected <T extends RepositoryDataContext> T _withRootObject(DataAwareAmetysObject rootObject)

Set the object from which the full data path is computed

Type Parameters:

T - the type of the retrieved DataContext

Parameters:

rootObject - the root object to set

Returns:

the current DataContext

getExternalizableData

public Set<String> getExternalizableData()

Retrieves the externalizable data

Returns:

the externalizable data

isDataExternalizable

public boolean isDataExternalizable()

Check if the current data is externalizable

Returns:

true if the data is externalizable, false otherwise

withExternalizableData

public <T extends RepositoryDataContext> T withExternalizableData(Set<String> externalizableData)

Sets the externalizable data

Type Parameters:

T - the type of the retrieved DataContext

Parameters:

externalizableData - the externalizable data to set

Returns:

the current RepositoryDataContext

copyExternalMetadata

public boolean copyExternalMetadata()

Check if the external metadata (alternative and status) should be copied

Returns:

true if the external metadata should be copied, false otherwise

withExternalMetadataInCopy

public <T extends RepositoryDataContext> T withExternalMetadataInCopy(boolean copyExternalMetadata)

Set to true to copy the external metadata (alternative and status) (default to false)

Type Parameters:

T - the type of the retrieved DataContext

Parameters:

copyExternalMetadata - true to copy the external metadata, false otherwise

Returns:

the current RepositoryDataContext