org.alfresco.repo.dictionary

Interface DictionaryDAO

All Known Implementing Classes:

DictionaryDAOImpl

public interface DictionaryDAO

Dictionary Data Access

Author:

David Caruana

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy the Dictionary
List<M2ModelDiff>	diffModel(M2Model model) Return diffs between input model and model in the Dictionary.
List<M2ModelDiff>	diffModelIgnoringConstraints(M2Model model)
TypeDefinition	getAnonymousType(QName type, Collection<QName> aspects) Construct an anonymous type that combines a primary type definition and and one or more aspects
AspectDefinition	getAspect(QName name) Gets the specified aspect
Collection<AspectDefinition>	getAspects(QName model)
AssociationDefinition	getAssociation(QName name) Gets the specified association
Collection<AssociationDefinition>	getAssociations(QName model)
ClassDefinition	getClass(QName name) Gets the specified class
ConstraintDefinition	getConstraint(QName name) Gets the specified property constraint
Collection<ConstraintDefinition>	getConstraints(QName model)
Collection<ConstraintDefinition>	getConstraints(QName model, boolean referenceableDefsOnly)
DataTypeDefinition	getDataType(Class javaClass) Gets the data type for the specified Java Class
DataTypeDefinition	getDataType(QName name) Gets the specified data type
Collection<DataTypeDefinition>	getDataTypes(QName model)
String	getDefaultAnalyserResourceBundleName()
ModelDefinition	getModel(QName name)
Collection<QName>	getModels()
Collection<NamespaceDefinition>	getNamespaces(QName modelName)
Collection<PropertyDefinition>	getProperties(QName model)
Collection<PropertyDefinition>	getProperties(QName modelName, QName dataType) Get all properties for the model and that are of the given data type.
Collection<PropertyDefinition>	getPropertiesOfDataType(QName dataType) Get all properties for all models of the given data type.
PropertyDefinition	getProperty(QName name) Gets the specified property
ClassLoader	getResourceClassLoader()
Collection<QName>	getSubAspects(QName superAspect, boolean follow)
Collection<QName>	getSubTypes(QName superType, boolean follow)
TypeDefinition	getType(QName name) Gets the specified type
Collection<TypeDefinition>	getTypes(QName model)
void	init() Initialise the Dictionary
boolean	isModelInherited(QName name)
QName	putModel(M2Model model) Adds a model to the dictionary.
QName	putModelIgnoringConstraints(M2Model model) Adds a model to the dictionary.
void	register(DictionaryListener dictionaryListener) Register listener with the Dictionary
void	removeModel(QName model) Removes a model from the dictionary.
void	reset() Reset the Dictionary - destroy & re-initialise
void	setResourceClassLoader(ClassLoader resourceClassLoader)

Method Detail

getModels

Collection<QName> getModels()

Returns:

the models known by the dictionary

getModel

ModelDefinition getModel(QName name)

Parameters:

name - the model to retrieve

Returns:

the named model definition

getDataTypes

Collection<DataTypeDefinition> getDataTypes(QName model)

Parameters:

model - the model to retrieve property types for

Returns:

the property types of the model

getTypes

Collection<TypeDefinition> getTypes(QName model)

Parameters:

model - the model to retrieve types for

Returns:

the types of the model

getSubTypes

Collection<QName> getSubTypes(QName superType,
                            boolean follow)

Parameters:

superType -

follow - true => follow up the super-class hierarchy, false => immediate sub types only

Returns:

getAspects

Collection<AspectDefinition> getAspects(QName model)

Parameters:

model - the model to retrieve aspects for

Returns:

the aspects of the model

getAssociations

Collection<AssociationDefinition> getAssociations(QName model)

Parameters:

model - the model to retrieve associations for

Returns:

the associations of the model

getSubAspects

Collection<QName> getSubAspects(QName superAspect,
                              boolean follow)

Parameters:

superAspect -

follow - true => follow up the super-class hierarchy, false => immediate sub aspects only

Returns:

getProperties

Collection<PropertyDefinition> getProperties(QName model)

Parameters:

model - the model for which to get properties for

Returns:

the properties of the model

getAnonymousType

TypeDefinition getAnonymousType(QName type,
                              Collection<QName> aspects)

Construct an anonymous type that combines a primary type definition and and one or more aspects

Parameters:

type - the primary type

aspects - the aspects to combine

Returns:

the anonymous type definition

putModel

QName putModel(M2Model model)

Adds a model to the dictionary. The model is compiled and validated.

Parameters:

model - the model to add

Returns:

QName name of model

putModelIgnoringConstraints

QName putModelIgnoringConstraints(M2Model model)

Adds a model to the dictionary. The model is compiled and validated. Constraints are not loaded. This method should only be used to load models where the enforcement of constraints is never required. For example, SOLR read only use of the index where contraints are not required and thier definitions may not be available.

Parameters:

model - the model to add

Returns:

QName name of model

removeModel

void removeModel(QName model)

Removes a model from the dictionary. The types and aspect in the model will no longer be available.

Parameters:

model - the qname of the model to remove

getProperties

Collection<PropertyDefinition> getProperties(QName modelName,
                                           QName dataType)

Get all properties for the model and that are of the given data type. If dataType is null then the all properties will be returned.

Parameters:

modelName - the name of the model

dataType - null to get all properties

Returns:

the properties associated with the model

getPropertiesOfDataType

Collection<PropertyDefinition> getPropertiesOfDataType(QName dataType)

Get all properties for all models of the given data type.

Parameters:

modelName -

dataType -

Returns:

getNamespaces

Collection<NamespaceDefinition> getNamespaces(QName modelName)

Parameters:

model - the model to retrieve namespaces for

Returns:

the namespaces of the model

getConstraints

Collection<ConstraintDefinition> getConstraints(QName model)

Parameters:

model - the model to retrieve constraint defs (including property constaint refs)

Returns:

the constraints of the model

getConstraints

Collection<ConstraintDefinition> getConstraints(QName model,
                                              boolean referenceableDefsOnly)

Parameters:

model - the model to retrieve constraint defs (optionally only referenceable constraints)

Returns:

the constraints of the model

diffModel

List<M2ModelDiff> diffModel(M2Model model)

Return diffs between input model and model in the Dictionary. If the input model does not exist in the Dictionary then no diffs will be returned.

Parameters:

model -

Returns:

model diffs (if any)

diffModelIgnoringConstraints

List<M2ModelDiff> diffModelIgnoringConstraints(M2Model model)

register

void register(DictionaryListener dictionaryListener)

Register listener with the Dictionary

Parameters:

dictionaryListener -

reset

void reset()

Reset the Dictionary - destroy & re-initialise

init

void init()

Initialise the Dictionary

destroy

void destroy()

Destroy the Dictionary

isModelInherited

boolean isModelInherited(QName name)

getDefaultAnalyserResourceBundleName

String getDefaultAnalyserResourceBundleName()

Returns:

getResourceClassLoader

ClassLoader getResourceClassLoader()

Returns:

setResourceClassLoader

void setResourceClassLoader(ClassLoader resourceClassLoader)

Parameters:

resourceClassLoader -

getDataType

DataTypeDefinition getDataType(QName name)

Gets the specified data type

Parameters:

name - name of the data type

Returns:

data type definition

getDataType

DataTypeDefinition getDataType(Class javaClass)

Gets the data type for the specified Java Class

Parameters:

javaClass - the java class

Returns:

the data type definition (or null, if mapping is not available)

getType

TypeDefinition getType(QName name)

Gets the specified type

Parameters:

name - name of the type

Returns:

type definition

getAspect

AspectDefinition getAspect(QName name)

Gets the specified aspect

Parameters:

name - name of the aspect

Returns:

aspect definition

getClass

ClassDefinition getClass(QName name)

Gets the specified class

Parameters:

name - name of the class

Returns:

class definition

getProperty

PropertyDefinition getProperty(QName name)

Gets the specified property

Parameters:

name - name of the property

Returns:

property definition

getConstraint

ConstraintDefinition getConstraint(QName name)

Gets the specified property constraint

Parameters:

name - the qualified name of the property constraint

Returns:

getAssociation

AssociationDefinition getAssociation(QName name)

Gets the specified association

Parameters:

name - name of the association

Returns:

association definition