Package se.conciliate.extensions.content

Interface RestContext

public interface RestContext

Loads and makes available a set of data for a context within the current workspace. All of the data in the context is loaded before it can be used, which makes this useful for operations such as exporting and publishing data. Note that individual chunks of data might be serialized to disk to keep down the memory footprint. This should be transparent to clients of the context other than that data should not be fetched on the EDT.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RestContext.DataType

Method Summary

Modifier and Type	Method	Description
RestAttribute	attribute(long id)
RestAttribute	attribute(String uuid)
void	dispose()	Disposes of the context.
RestDocument	document(String uuid)	Deprecated.
RestDocument	document(Document document)	Deprecated.
RestDocument	document(Document.DocumentID id)	Deprecated.
Stream<RestDocument>	documents()	Deprecated.
RestDocumentType	documentType(long id)
RestDocumentType	documentType(String uuid)
boolean	isLoaded()	returns true if the context is loaded
RestLayer	layer(Long id)
RestLayer	layer(String uuid)
void	load(BiConsumer<String,Integer> progress)	Loads all data in the context.
void	loadAdditionalModels(Collection<Long> modelIDs)	Adds more models and loads data for added models in an already loaded context.
void	loadAdditionalObjects(Collection<Long> objectIDs)	Adds more objects and loads data for added models in an already loaded context.
RestModel	model(long id)
RestModel	model(String uuid)
Set<Long>	modelIDs()
Stream<RestModel>	models()
Set<Long>	modelsContainingObject(String uuid)
RestObject	object(long id)
RestObject	object(String uuid)
Set<Long>	objectIDs()
Stream<RestObject>	objects()

Method Details

load

void load(BiConsumer<String,Integer> progress)

Loads all data in the context.

Parameters:

progress - Progress callback with message and percent of completion. A percent value of -1 means that the current stage is indeterminate.

isLoaded

boolean isLoaded()

returns true if the context is loaded

loadAdditionalModels

void loadAdditionalModels(Collection<Long> modelIDs)

Adds more models and loads data for added models in an already loaded context.

Parameters:

modelIDs - The set of models to be added in to the context. is indeterminate.

loadAdditionalObjects

void loadAdditionalObjects(Collection<Long> objectIDs)

Adds more objects and loads data for added models in an already loaded context. Also loads a model that uses the newly loaded objects.

Parameters:

objectIDs - The set of objects to be added in to the context. is indeterminate.

dispose

void dispose()

Disposes of the context. Always do this when not using it anymore to make sure the context is not remaining in db storage.

modelIDs

Set<Long> modelIDs()

model

RestModel model(long id)

model

RestModel model(String uuid)

models

Stream<RestModel> models()

objectIDs

Set<Long> objectIDs()

objects

Stream<RestObject> objects()

object

RestObject object(long id)

object

RestObject object(String uuid)

modelsContainingObject

Set<Long> modelsContainingObject(String uuid)

documentType

RestDocumentType documentType(long id)

documentType

RestDocumentType documentType(String uuid)

attribute

RestAttribute attribute(long id)

attribute

RestAttribute attribute(String uuid)

layer

RestLayer layer(Long id)

layer

RestLayer layer(String uuid)

document

@Deprecated
RestDocument document(Document.DocumentID id)

Deprecated.

document

@Deprecated
RestDocument document(String uuid)

Deprecated.

document

@Deprecated
RestDocument document(Document document)

Deprecated.

documents

@Deprecated
Stream<RestDocument> documents()

Deprecated.