codeable_models.CClassifier¶

class codeable_models.CClassifier(name=None, **kwargs)¶

CClassifier is superclass of classifiers such as CClass and CMetaclass defining common features for classifiers. The class is usually not used directly but its features are used from the subclasses.

Superclasses: CBundlable

Parameters

name (str) – An optional name.
**kwargs –
Pass in any kwargs acceptable to superclasses. In addition, CClassifier accepts: attributes, superclasses.
- The attributes kwarg accepts a dict of attributes in the form acceptable to the attributes property.
- The superclasses kwarg accepts a list of superclasses in the form acceptable to the superclasses property.

Examples:

The following code uses the superclasses and attributes features of CClassifier during a class definition and then uses the association feature to define an association for a class:

customer = CClass(domain_metaclass, "Customer", superclasses=person, attributes={
    "id": str,
    "shipping addresses": [],
})

customer.association(cart, "shops with: [customer] 1 <*>- [cart] 1")

Main Relations:

The main relations of CClassifier are shown in the figure below.

As can be seen, CClass, CMetaclass, and CStereotype are classifiers, as could be expected. In addition, CAssociation is a classifier, which might be a less obvious design choice. It is a classifier, so that a CLink can be an object. That is, the association is the classifier of the link. This way links can be referenced and treated as objects.

The associations, attributes, and inheritance hierarchy of a classifier are managed by the methods of CClassifier.

property all_associations¶

Getter listing all associations of this classifier including those of superclasses.

Type: list[CAssociation]

property all_subclasses¶

Getter that returns all subclasses of this classifier on the inheritance hierarchy.

Type: list[CClassifier]

property all_superclasses¶

Getter that returns all superclasses of this classifier on the inheritance hierarchy.

Type: list[CClassifier]

association(target, descriptor=None, **kwargs)¶

Method used to create associations on this classifier. Returns the CAssociation that is created.

Parameters

target – The association target classifier.
descriptor – An optional descriptor making it easier to define associations with a simple string.
**kwargs – Accepts all keyword arguments acceptable to CAssociation to define associations.

Returns

The created association.

Return type

CAssociation

For explanation of descriptor syntax and supported keyword arguments see documentation of the constructor of CAssociation.

property associations¶

Getter listing associations of this classifier.

Type: list[CAssociation]

property attribute_names¶

Returns a list of all attribute names defined for this classifier.

Examples are provided in the document Class attributes.

Type: list[str]

property attributes¶

Property that gets the list of attributes of a classifier or sets them using a dictionary.

All attributes are internally stored as CAttribute objects. The getter returns the list of all attributes as CAttribute objects.

For the setter, None or {} can be used to remove all attributes from the classifier.

Each attribute in the dict is specified using the form:

attributeName: <type|default-value|CAttribute>

Possible types of attributes are:

bool: a boolean

int: an integer

float: a floating point number

str: a string

list: a Python list

enumeration values: An object of type CEnum is the type and enumeration values are used as attribute values.

objects: A class of type CClassifier is the type and CObject’s are used as attribute values. Please note this might be CClass as a type with CObject objects, or CMetaclass as a type with CClass objects.

CAttribute objects: An CAttribute object describes an attribute, i.e., its type and default value.

Example: The following code initialized one int and one bool attribute, each with a default value, and it defines another string attribute using the str type:

game = CClass(metaclass, "Game", attributes={
    "number_of_players": 1,
    "game_started": False,
    "player_id": str
})

game.attributes returns the list of attributes as CAttribute objects.

More examples are provided in the document Class attributes.

Type: dict[str, CAttribute | Attribute Type | Default Value]

property class_path¶

Superclasses are processed using a linerarized class path. This path unambiguously orders the superclasses for each classifier, from lower-level to higher-level classes. At the same level, classes will be ordered in the same order as specified in the superclasses definitions. If a classifier appears multiple times on the class path, i.e. it is reachable via different paths, the first appearance is chosen.

This getter returns all superclasses in the order of the class path.

Type: list[CClassifier]

delete()¶: Deletes the classifier, removes superclasses, removes it from subclasses, removes all associations and attributes, and removes the classifier from bundles. Calls delete() on superclass.

get_attribute(attribute_name)¶

Returns the CAttribute object that conforms to the provided attribute name. If none is found, None is returned.

Examples are provided in the document Class attributes.

Returns: The attribute conforming to the attribute name.
Return type: CAttribute

has_subclass(classifier)¶

Returns True if classifier is subclass of this classifier, else False.

Parameters: classifier – The classifier to test.
Returns: Boolean result of the check
Return type: bool

has_superclass(classifier)¶

Returns True if classifier is superclass of this classifier, else False.

Parameters: classifier – The classifier to test.
Returns: Boolean result of the check
Return type: bool

is_classifier_of_type(classifier)¶

Checks if the classifier conforms to the provided classifier’s type.

Parameters: classifier – A CClassifier to check against.
Returns: Boolean result of the check.
Return type: bool

property subclasses¶

Getter that returns the subclasses of this classifier.

Type: list[CClassifier]

property superclasses¶

Setter to set and getter to return the superclasses of this classifier.

Type: list[CClassifier]