Package se.conciliate.extensions.store.query

Interface MTDocumentSourceQuery

All Superinterfaces:

MTContextQuery, MTPatternQuery, MTQuery

public interface MTDocumentSourceQuery
extends MTQuery, MTPatternQuery, MTContextQuery

Nested Class Summary

Nested classes/interfaces inherited from interface se.conciliate.extensions.store.query.MTQuery

MTQuery.ResultContext, MTQuery.SortColumn, MTQuery.State

Method Summary

Modifier and Type	Method	Description
MTDocumentSourceQuery	select(List<Document.DocumentID> ids)	Selects documents by their IDs.
MTDocumentSourceQuery	select(MTList list)	Selects MT documents by executing a list.
MTDocumentSourceQuery	selectAll()	Selects all documents from all sources
MTDocumentSourceQuery	selectByModels(Collection<MTModelHeader> models)
MTDocumentSourceQuery	selectByModels(MTModelHeader... models)	Selects documents that are used in given models.
MTDocumentSourceQuery	selectByModelsAndSymbols(Collection<MTModelHeader> models)
MTDocumentSourceQuery	selectByModelsAndSymbols(MTModelHeader... models)	Selects documents that are used in given models and objects.
MTDocumentSourceQuery	selectBySymbols(Collection<MTSymbolHeader> symbols)
MTDocumentSourceQuery	selectBySymbols(MTSymbolHeader... symbols)	Selects documents that are used in given objects.
MTDocumentSourceQuery	selectUnused()	Selects documents from all sources that are not connected to models or objects in the repository.
MTDocumentSourceQuery	sort(MetaDataType sortBy, boolean ascending, MTLanguage language, Locale locale)	Sorts the selected documents.
MTDocumentSourceQuery	withFilter(DocumentFilter filter)	Selects documents matching a document filter.
MTDocumentSourceQuery	withPattern(String pattern, MTLanguage language, boolean exactMatch, boolean ignoreCase)	Excludes results where the title does not contain pattern as a substring.
MTDocumentSourceQuery	withSources(Collection<DocumentSource> sources)	Selects documents from selected sources.

Methods inherited from interface se.conciliate.extensions.store.query.MTContextQuery

storeContexts, storeContextsLockedRevisions

Methods inherited from interface se.conciliate.extensions.store.query.MTQuery

attributeTypes, clear, colorSchemes, documents, documentSources, documentTypes, entityProperties, execute, getResultTypes, getState, images, layerTypes, lists, models, pluginData, publishProfiles, serialize, subscribers, symbols, timestamps, users, variables, workspacePluginData

Method Details

selectAll

MTDocumentSourceQuery selectAll()

Selects all documents from all sources

selectUnused

MTDocumentSourceQuery selectUnused()

Selects documents from all sources that are not connected to models or objects in the repository.

select

MTDocumentSourceQuery select(List<Document.DocumentID> ids)

Selects documents by their IDs.

Parameters:

ids - The ID:s of the documents to select, per source.

selectByModelsAndSymbols

MTDocumentSourceQuery selectByModelsAndSymbols(MTModelHeader... models)

Selects documents that are used in given models and objects.

Parameters:

models - The models.

selectByModelsAndSymbols

MTDocumentSourceQuery selectByModelsAndSymbols(Collection<MTModelHeader> models)

selectByModels

MTDocumentSourceQuery selectByModels(MTModelHeader... models)

Selects documents that are used in given models.

Parameters:

models - The models.

selectByModels

MTDocumentSourceQuery selectByModels(Collection<MTModelHeader> models)

selectBySymbols

MTDocumentSourceQuery selectBySymbols(MTSymbolHeader... symbols)

Selects documents that are used in given objects.

Parameters:

symbols - The symbols.

selectBySymbols

MTDocumentSourceQuery selectBySymbols(Collection<MTSymbolHeader> symbols)

select

MTDocumentSourceQuery select(MTList list)

Selects MT documents by executing a list.

Parameters:

list - The list to execute.

Throws:

IllegalArgumentException - If list.getResultType() != MTList.ResultType.DOCUMENT.

withSources

MTDocumentSourceQuery withSources(Collection<DocumentSource> sources)

Selects documents from selected sources.

Parameters:

sources - The sources.

withFilter

MTDocumentSourceQuery withFilter(DocumentFilter filter)

Selects documents matching a document filter.

Parameters:

filter - The filter to apply.

sort

MTDocumentSourceQuery sort(MetaDataType sortBy,
 boolean ascending,
 MTLanguage language,
 Locale locale)

Sorts the selected documents.

Parameters:

sortBy - The meta-data type to sort by

ascending - true for ascending order, false for descending

language - The 2c8 language to sort by, if applicable

locale - the locale to use when sorting, will represent application language.

withPattern

MTDocumentSourceQuery withPattern(String pattern,
 MTLanguage language,
 boolean exactMatch,
 boolean ignoreCase)

Excludes results where the title does not contain pattern as a substring.

Specified by:

withPattern in interface MTPatternQuery

Parameters:

pattern - The pattern to search for.

language - The language of the title to find the pattern in.

exactMatch - Require the pattern to match the title exactly rather than containing the pattern.

ignoreCase - Ignores case. This makes "exact match" check lowercase strings for equality and "contains match" check lowercase for contains.