edu.ksu.cis.cadena.core.specification.style
Interface Style

All Superinterfaces:

CalmObject, TypeDefContainer

public interface Style
extends CalmObject, TypeDefContainer

A representation of the model object 'Style'.

The following features are supported:

• Name
• Kinds
• Metakinds
• Parent
• Elided

See Also:

StylePackage.getStyle()

Method Summary

java.util.List<Style>	getAllParentStyles() Returns the list of all parent styles that a particular style inherits from (directly and transitively).
EList	getElided() Returns the value of the 'Elided' reference list.
EList	getKinds() Returns the value of the 'Kinds' containment reference list.
EList	getMetakinds() Returns the value of the 'Metakinds' containment reference list.
java.lang.String	getName() Returns the value of the 'Name' attribute.
EList	getParent() Returns the value of the 'Parent' reference list.
java.util.List<Kind>	getTypedElided() Convenience method that casts the return value of getElided() into a typed List.
java.util.List<Kind>	getTypedKinds() Convenience method that casts the return value of getKinds() into a typed List.
java.util.List<MetaKind>	getTypedMetakinds() Convenience method that casts the return value of getMetakinds() into a typed List.
java.util.List<Style>	getTypedParent() Convenience method that casts the return value of getParent() into a typed List.
<T extends Kind> java.util.List<T>	getVisibleKinds(java.lang.Class<T> clazz, boolean includeElided) Helper method for finding all of the kinds that are visible from this style.
java.util.List<MetaKind>	getVisibleMetaKinds() Helper method for finding all of the visible meta kinds in this style and all parent styles.
<T extends MetaKind> java.util.List<T>	getVisibleMetaKinds(java.lang.Class<T> clazz) Helper method for findig all of the visible meta kinds of a given type for this style and all of its parent styles.
<T extends MetaKind> java.util.List<T>	getVisibleMetaKinds(java.lang.Class<T> clazz, MetaKind baseMetaKind) Helper method for finding all of the visible meta kinds of a given type which extend from a given base meta kind for this style and all parent styles.
boolean	hasCircularInheritance() Calculates whether or not this Style inherits from itself.
boolean	isKindVisible(Kind kind) Helper method to determine if there is a non-eliding path to the specified kind.
void	setName(java.lang.String value) Sets the value of the 'Name' attribute.

Methods inherited from interface edu.ksu.cis.cadena.core.specification.base.CalmObject

addBackReference, getBackReferences, getDeleted, getTrashCan, getUuid, removeBackReference

Methods inherited from interface edu.ksu.cis.cadena.core.specification.property.TypeDefContainer

getAllTypeDefs, getTypeDefs, getTypedTypeDefs

Method Detail

getName

java.lang.String getName()

Returns the value of the 'Name' attribute.

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), StylePackage.getStyle_Name()

setName

void setName(java.lang.String value)

Sets the value of the 'Name' attribute.

Parameters:

value - the new value of the 'Name' attribute.

See Also:

getName()

getKinds

EList getKinds()

Returns the value of the 'Kinds' containment reference list. The list contents are of type Kind.

Returns:

the value of the 'Kinds' containment reference list.

See Also:

StylePackage.getStyle_Kinds()

getMetakinds

EList getMetakinds()

Returns the value of the 'Metakinds' containment reference list. The list contents are of type MetaKind.

Returns:

the value of the 'Metakinds' containment reference list.

See Also:

StylePackage.getStyle_Metakinds()

getParent

EList getParent()

Returns the value of the 'Parent' reference list. The list contents are of type Style.

This list contains all of the styles from which this style inherit from.

Returns:

the value of the 'Parent' reference list.

See Also:

StylePackage.getStyle_Parent()

getElided

EList getElided()

Returns the value of the 'Elided' reference list. The list contents are of type Kind.

Returns:

the value of the 'Elided' reference list.

See Also:

StylePackage.getStyle_Elided()

getTypedParent

java.util.List<Style> getTypedParent()

Convenience method that casts the return value of getParent() into a typed List.

Returns:

The typed list

See Also:

getParent()

getTypedElided

java.util.List<Kind> getTypedElided()

Convenience method that casts the return value of getElided() into a typed List.

Returns:

The typed list

See Also:

getElided()

getTypedKinds

java.util.List<Kind> getTypedKinds()

Convenience method that casts the return value of getKinds() into a typed List.

Returns:

The typed list

See Also:

getKinds()

getTypedMetakinds

java.util.List<MetaKind> getTypedMetakinds()

Convenience method that casts the return value of getMetakinds() into a typed List.

Returns:

The typed list

See Also:

getMetakinds()

getAllParentStyles

java.util.List<Style> getAllParentStyles()

Returns the list of all parent styles that a particular style inherits from (directly and transitively). The returned list is not backed by the model.

Returns:

The computed parent List

hasCircularInheritance

boolean hasCircularInheritance()

Calculates whether or not this Style inherits from itself.

Returns:

true if the style has circular inheritance, false otherwise.

getVisibleKinds

<T extends Kind> java.util.List<T> getVisibleKinds(java.lang.Class<T> clazz,
                                                   boolean includeElided)

Helper method for finding all of the kinds that are visible from this style.

Type Parameters:

T - The specific type of kind to look for.

Parameters:

clazz - The class that matches the type of type parameter T

includeElided - If true, the return value will include kinds which normally aren't visible due to elision. Otherwise, these kinds are not included in the return value.

Returns:

The list of visible kinds.

getVisibleMetaKinds

java.util.List<MetaKind> getVisibleMetaKinds()

Helper method for finding all of the visible meta kinds in this style and all parent styles.

Returns:

The list of visible meta kinds

See Also:

getVisibleMetaKinds()

getVisibleMetaKinds

<T extends MetaKind> java.util.List<T> getVisibleMetaKinds(java.lang.Class<T> clazz)

Helper method for findig all of the visible meta kinds of a given type for this style and all of its parent styles.

Type Parameters:

T - The specified type of meta kind to look for

Parameters:

clazz - The class that matches the type of type parameter T

Returns:

The list of visible meta kinds

getVisibleMetaKinds

<T extends MetaKind> java.util.List<T> getVisibleMetaKinds(java.lang.Class<T> clazz,
                                                           MetaKind baseMetaKind)

Helper method for finding all of the visible meta kinds of a given type which extend from a given base meta kind for this style and all parent styles.

Type Parameters:

T - The specified type of meta kind to look for

Parameters:

clazz - The class that matches the type of type parameter T

baseMetaKind - The base meta kind which all of the return metakinds should extend from.

Returns:

The metakinds that were found

isKindVisible

boolean isKindVisible(Kind kind)

Helper method to determine if there is a non-eliding path to the specified kind.

Parameters:

kind -

Returns:

true if a non-eliding path exists, false otherwise