DictionaryService (Alfresco 5.2.4 Public Java API)

org.alfresco.service.cmr.dictionary

Interface DictionaryService

All Superinterfaces:

@org.alfresco.api.AlfrescoPublicApi
public interface DictionaryService

This interface represents the Repository Data Dictionary. The dictionary provides access to content meta-data such as Type and Aspect descriptions.

Content meta-data is organised into models where each model is given a qualified name. This means that it is safe to develop independent models and bring them together into the same Repository without name clashes (as long their namespace is different).

Method Summary
Collection<QName>	getAllAspects()
Collection<QName>	getAllAspects(boolean includeInherited)
Collection<QName>	getAllAssociations() Get all the association definitions
Collection<QName>	getAllAssociations(boolean includeInherited)
Collection<QName>	getAllDataTypes()
Collection<QName>	getAllModels()
Collection<QName>	getAllProperties(QName dataType) Get all properties defined across all models with the given data type.
Collection<QName>	getAllTypes()
Collection<QName>	getAllTypes(boolean includeInherited)
TypeDefinition	getAnonymousType(QName name) Creates an anonymous TypeDefinition with all the mandatory Aspects applied.
TypeDefinition	getAnonymousType(QName type, Collection<QName> aspects) Construct an anonymous type that combines the definitions of the specified type and aspects.
AspectDefinition	getAspect(QName name)
Collection<QName>	getAspects(QName model)
AssociationDefinition	getAssociation(QName associationName) Gets the definition of the association as defined by its owning Class.
Collection<QName>	getAssociations(QName model)
ClassDefinition	getClass(QName name)
ConstraintDefinition	getConstraint(QName constraintQName) Gets the definition of the constraint
Collection<ConstraintDefinition>	getConstraints(QName model) Get constraints for the specified model
Collection<ConstraintDefinition>	getConstraints(QName model, boolean referenceableDefsOnly) Get constraints for the specified model Optionally return referenceable (ie.
DataTypeDefinition	getDataType(Class<?> javaClass)
DataTypeDefinition	getDataType(QName name)
Collection<QName>	getDataTypes(QName model)
ModelDefinition	getModel(QName model)
ModelDefinition	getModelByNamespaceUri(String uri)
Collection<QName>	getProperties(QName model) Get all properties for the specified model
Collection<QName>	getProperties(QName model, QName dataType) Get all properties defined for the given model with the given data type.
PropertyDefinition	getProperty(QName propertyName) Gets the definition of the property as defined by its owning Class.
PropertyDefinition	getProperty(QName className, QName propertyName) Gets the definition of the property as defined by the specified Class.
Map<QName,PropertyDefinition>	getPropertyDefs(QName className) Gets the definitions of the properties defined by the specified Class.
Collection<QName>	getSubAspects(QName aspect, boolean follow)
Collection<QName>	getSubTypes(QName type, boolean follow) Get the sub types of the type.
TypeDefinition	getType(QName name)
Collection<QName>	getTypes(QName model)
boolean	isSubClass(QName className, QName ofClassName) Determines whether a class is a sub-class of another class

Methods inherited from interface org.alfresco.service.cmr.i18n.MessageLookup

getMessage, getMessage, getMessage, getMessage

the names of all models that have been registered with the Repository

model - the model name to retrieve

the specified model (never null)

DictionaryException - if the model could not be found

@NotAuditable
Collection<QName> getAllDataTypes()

the names of all data types that have been registered with the Repository

@NotAuditable
Collection<QName> getDataTypes(QName model)

model - the model to retrieve data types for

the names of all data types defined within the specified model

name - the name of the data type to retrieve

the data type definition (or null, if it doesn't exist)

@NotAuditable
DataTypeDefinition getDataType(Class<?> javaClass)

javaClass - java class to find datatype for

the data type definition (or null, if a mapping does not exist)

the names of all types that have been registered with the Repository

@NotAuditable
Collection<QName> getAllTypes(boolean includeInherited)

@NotAuditable
Collection<QName> getSubTypes(QName type,
boolean follow)

Get the sub types of the type. The returned list includes the base type which is passed in as a parameter.

type - the qualified name of the type

follow - true => all sub-type descendants, false => immediate sub-type children

the names of the sub types of the specified type, including the value passed in.

model - the model to retrieve types for

the names of all types defined within the specified model

name - the name of the type to retrieve

the type definition (or null, if it doesn't exist)

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

Construct an anonymous type that combines the definitions of the specified type and aspects.

type - the type to start with

aspects - the aspects to combine with the type

the anonymous type definition

TypeDefinition getAnonymousType(QName name)

Creates an anonymous TypeDefinition with all the mandatory Aspects applied. This collapses all mandatory Aspects into a single TypeDefinition.

name - the name of the type definition.

the anonymous type definition

@NotAuditable
Collection<QName> getAllAspects()

the names of all aspects that have been registered with the Repository

@NotAuditable
Collection<QName> getAllAspects(boolean includeInherited)

@NotAuditable
Collection<QName> getSubAspects(QName aspect,
boolean follow)

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

the sub aspects of specified aspect

@NotAuditable
Collection<QName> getAspects(QName model)

model - the model to retrieve aspects for

the names of all aspects defined within the specified model

@NotAuditable
Collection<QName> getAssociations(QName model)

model - the model to retrieve associations for

the names of all associations defined within the specified model

name - the name of the aspect to retrieve

the aspect definition (or null, if it doesn't exist)

name - the name of the class (type or aspect) to retrieve

the class definition (or null, if it doesn't exist)

@NotAuditable
boolean isSubClass(QName className,
QName ofClassName)

Determines whether a class is a sub-class of another class

className - the sub-class to test

ofClassName - the class to test against

true => the class is a sub-class (or itself)

@NotAuditable
PropertyDefinition getProperty(QName className,
QName propertyName)

Gets the definition of the property as defined by the specified Class. Note: A sub-class may override the definition of a property that's defined in a super-class.

className - the class name

propertyName - the property name

the property definition (or null, if it doesn't exist)

@NotAuditable
Map<QName,PropertyDefinition> getPropertyDefs(QName className)

Gets the definitions of the properties defined by the specified Class.

className - the class name

the property definitions

@NotAuditable
PropertyDefinition getProperty(QName propertyName)

Gets the definition of the property as defined by its owning Class.

propertyName - the property name

the property definition (or null, if it doesn't exist)

@NotAuditable
Collection<QName> getAllProperties(QName dataType)

Get all properties defined across all models with the given data type. Note that DataTypeDefinition.ANY will only match this type and can not be used as get all properties. If dataType is null then this method will return *ALL* properties regardless of data type.

@NotAuditable
Collection<QName> getProperties(QName model,
QName dataType)

Get all properties defined for the given model with the given data type. Note that DataTypeDefinition.ANY will only match this type and can not be used as get all properties. If dataType is null then this method will return *ALL* properties regardless of data type.