|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
---|---|
java.util.Collection |
getAllAspects()
|
java.util.Collection |
getAllAssociations()
Get all the association definitions |
java.util.Collection |
getAllDataTypes()
|
java.util.Collection |
getAllModels()
|
java.util.Collection |
getAllProperties(QName dataType)
Get all properties defined across all models with the given data type. |
java.util.Collection |
getAllTypes()
|
TypeDefinition |
getAnonymousType(QName name)
Creates an anonymous TypeDefinition with all the mandatory Aspects applied. |
TypeDefinition |
getAnonymousType(QName type,
java.util.Collection aspects)
Construct an anonymous type that combines the definitions of the specified type and aspects. |
AspectDefinition |
getAspect(QName name)
|
java.util.Collection |
getAspects(QName model)
|
AssociationDefinition |
getAssociation(QName associationName)
Gets the definition of the association as defined by its owning Class. |
java.util.Collection |
getAssociations(QName model)
|
ClassDefinition |
getClass(QName name)
|
ConstraintDefinition |
getConstraint(QName constraintQName)
Gets the definition of the constraint |
java.util.Collection |
getConstraints(QName model)
Get constraints for the specified model |
java.util.Collection |
getConstraints(QName model,
boolean referenceableDefsOnly)
Get constraints for the specified model Optionally return referenceable (ie. |
DataTypeDefinition |
getDataType(java.lang.Class javaClass)
|
DataTypeDefinition |
getDataType(QName name)
|
java.util.Collection |
getDataTypes(QName model)
|
ModelDefinition |
getModel(QName model)
|
java.util.Collection |
getProperties(QName model)
Get all properties for the specified model |
java.util.Collection |
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. |
java.util.Map |
getPropertyDefs(QName className)
Gets the definitions of the properties defined by the specified Class. |
java.util.Collection |
getSubAspects(QName aspect,
boolean follow)
|
java.util.Collection |
getSubTypes(QName type,
boolean follow)
Get the sub types of the type. |
TypeDefinition |
getType(QName name)
|
java.util.Collection |
getTypes(QName model)
|
boolean |
isSubClass(QName className,
QName ofClassName)
Determines whether a class is a sub-class of another class |
Method Detail |
---|
@NotAuditable java.util.Collection getAllModels()
@NotAuditable ModelDefinition getModel(QName model)
model
- the model name to retrieve
@NotAuditable java.util.Collection getAllDataTypes()
@NotAuditable java.util.Collection getDataTypes(QName model)
model
- the model to retrieve data types for
@NotAuditable DataTypeDefinition getDataType(QName name)
name
- the name of the data type to retrieve
@NotAuditable DataTypeDefinition getDataType(java.lang.Class javaClass)
javaClass
- java class to find datatype for
@NotAuditable java.util.Collection getAllTypes()
@NotAuditable java.util.Collection getSubTypes(QName type, boolean follow)
type,
- the qualified name of the typefollow
- true => all sub-type descendants, false => immediate sub-type children
@NotAuditable java.util.Collection getTypes(QName model)
model
- the model to retrieve types for
@NotAuditable TypeDefinition getType(QName name)
name
- the name of the type to retrieve
@NotAuditable TypeDefinition getAnonymousType(QName type, java.util.Collection aspects)
type
- the type to start withaspects
- the aspects to combine with the type
TypeDefinition getAnonymousType(QName name)
TypeDefinition
with all the mandatory Aspects
applied.
This collapses all mandatory Aspects
into a single TypeDefinition
.
name
- the name of the type definition.
@NotAuditable java.util.Collection getAllAspects()
@NotAuditable java.util.Collection getSubAspects(QName aspect, boolean follow)
aspect
- follow
- true => follow up the super-class hierarchy, false => immediate sub aspects only
@NotAuditable java.util.Collection getAspects(QName model)
model
- the model to retrieve aspects for
@NotAuditable java.util.Collection getAssociations(QName model)
model
- the model to retrieve associations for
@NotAuditable AspectDefinition getAspect(QName name)
name
- the name of the aspect to retrieve
@NotAuditable ClassDefinition getClass(QName name)
name
- the name of the class (type or aspect) to retrieve
@NotAuditable boolean isSubClass(QName className, QName ofClassName)
className
- the sub-class to testofClassName
- the class to test against
@NotAuditable PropertyDefinition getProperty(QName className, QName propertyName)
className
- the class namepropertyName
- the property name
@NotAuditable java.util.Map getPropertyDefs(QName className)
className
- the class name
@NotAuditable PropertyDefinition getProperty(QName propertyName)
propertyName
- the property name
@NotAuditable java.util.Collection getAllProperties(QName dataType)
dataType
-
@NotAuditable java.util.Collection getProperties(QName model, QName dataType)
dataType
-
java.util.Collection getProperties(QName model)
model
-
@NotAuditable AssociationDefinition getAssociation(QName associationName)
associationName
- the property name
@NotAuditable java.util.Collection getAllAssociations()
@NotAuditable ConstraintDefinition getConstraint(QName constraintQName)
constraintName
- the constraint name
java.util.Collection getConstraints(QName model)
model
-
java.util.Collection getConstraints(QName model, boolean referenceableDefsOnly)
model
- referenceableDefsOnly
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |