Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 3.55 KB

alfresco-data-model.dictionary.md

File metadata and controls

38 lines (28 loc) · 3.55 KB

Home > @xenit/alfresco-data-model > Dictionary

Dictionary class

Dictionary implementation that keeps all classes, properties and associations in-memory

Signature:

export default class Dictionary implements IDictionary 

Implements: IDictionary

Constructors

Constructor Modifiers Description
(constructor)(classes, properties, associations) Creates the dictionary

Methods

Method Modifiers Description
getAllAssociationsForClass(qname) Retrieves all associations that are present on a node of a certain class, including inherited associations and properties on mandatory aspectsThe associations are returned from this function are ordered by the class in which they appear, then in the order that they are declared in the class.
getAllClassesForClass(qname) Retrieves all classes that are present on a node of a certain class, either directly, through inheritance or through specified mandatory aspects.The returned classes are ordered in inheritance order (parents first), with mandatory aspects of a class immediately after the class that declares them.
getAllPropertiesForClass(qname) Retrieves all properties that are present on a node of a certain class, including inherited properties and properties on mandatory aspectsThe properties are returned from this function are ordered by the class in which they appear, then in the order that they are declared in the class.
getAssociation(qname) Retrieves an association definition by it's qname
getAssociations() Retrieves all known associations
getChildrenForClass(qname) Retrieves all child classes.A child class is any class that has the requested class somewhere in the parent chain.The returned classes are in no particular order.
getClass(qname) Retrieves a type or aspect definition by it's qname
getClasses() Retrieves all known classes
getMandatoryAspectsForClass(qname) Retrieves all mandatory aspects of a class, direct, inherited through parents or through mandatory aspects.The returned classes are ordered in declaration order on the specified object, then in inheritance order with parents first.Note that an aspect is also allowed to specify mandatory aspects and a parent aspect.
getParentsForClass(qname) Retrieves all parent classes.The returned classes are ordered in inheritance order with parents first.
getProperties() Retrieves all known properties
getProperty(qname) Retrieves a property definition by it's qname