Package jetbrains.mps.smodel.adapter.structure.concept

Class SAbstractConceptAdapter

java.lang.Object

jetbrains.mps.smodel.adapter.structure.SNamedElementAdapter

jetbrains.mps.smodel.adapter.structure.concept.SAbstractConceptAdapter

All Implemented Interfaces:

ConceptMetaInfoConverter, SAbstractConcept, SElement, SNamedElement

Direct Known Subclasses:

InvalidConcept, SConceptAdapter, SInterfaceConceptAdapter

public abstract class SAbstractConceptAdapter
extends SNamedElementAdapter
implements SAbstractConcept, ConceptMetaInfoConverter

Common ancestor of adapter classes SConceptAdapter and SInterfaceConceptAdapter. It serves as an adapter from ConceptDescriptor to SAbstractConcept and the base class for all the implementations of the SAbstractConcept. The common idea is that on every client request it looks for the proper ConceptDescriptor in the special registry and redirects the client request to it. So it has only an id (string or smth else) as its state.

One calls the SAbstractConcept instance <\it>valid if and only if its ConceptDescriptor is present (getConceptDescriptor() != null).

Whenever the descriptor is absent (the concept instance is NOT valid) the "fail-safe" behavior is provided: please look at each method individually to acknowledge the contract.

NB: If a client of this API wants to distinguish the case when the concept is invalid, he/she needs to use the method isValid(). (!)

Currently a lot of "hacks" introduced to fix some common cases (e.g. not valid concept still is a subconcept of the BaseConcept). Also there is an editor issue when an instance of abstract concept (interface concept) might be created. (E.g. the method isSubConceptOf(SAbstractConcept) works not as expected for such concepts)

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID_DELIM

Fields inherited from class jetbrains.mps.smodel.adapter.structure.SNamedElementAdapter

myFqName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SAbstractConceptAdapter(String fqName)

Method Summary

Modifier and Type	Method	Description
SContainmentLink	convertAggregation(String role)
SReferenceLink	convertAssociation(String role)
SProperty	convertProperty(String propertyName)
static SAbstractConcept	deserialize(String s)
protected abstract SNode	findInModel(SModel structureModel)	a helper method to get a declaration node for this concept in the case of the legacy concept resolving (by string id)
String	getConceptAlias()
abstract ConceptDescriptor	getConceptDescriptor()
Collection<SContainmentLink>	getContainmentLinks()	Returns all the links this concept has, including inherited There's no "specialized links" at the compiled language level, all links are "original"
SNode	getDeclarationNode()	Deprecated.
protected NamedElementDescriptor	getDescriptor()
String	getHelpUrl()
Collection<SProperty>	getProperties()	Returns all the properties this concept has, including inherited
Collection<SReferenceLink>	getReferenceLinks()	Returns all the references this concept has, including inherited
String	getShortDescription()
boolean	hasLink(SContainmentLink l)
boolean	hasProperty(SProperty p)
boolean	hasReference(SReferenceLink r)
boolean	isAbstract()
boolean	isSubConceptOf(SAbstractConcept anotherConcept)	Either implementing or extending the supplied concept
protected abstract boolean	isSubConceptOfSpecial(ConceptDescriptor thisDescriptor, ConceptDescriptor anotherDescriptor, SAbstractConcept anotherConcept)
boolean	isValid()	Returns true if this concept is fully-functional.
abstract String	serialize()
String	toString()

Methods inherited from class jetbrains.mps.smodel.adapter.structure.SNamedElementAdapter

getName, getSourceNode, isBootstrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jetbrains.mps.openapi.language.SAbstractConcept

getLanguage, getName, getQualifiedName, getSourceNode

Field Detail

ID_DELIM

public static final String ID_DELIM

See Also:

Constant Field Values

Constructor Detail

SAbstractConceptAdapter

protected SAbstractConceptAdapter(String fqName)

Method Detail

getConceptDescriptor

@Nullable
public abstract ConceptDescriptor getConceptDescriptor()

Returns:

the backing ConceptDescriptor

getDescriptor

protected final NamedElementDescriptor getDescriptor()

Specified by:

getDescriptor in class SNamedElementAdapter

findInModel

protected abstract SNode findInModel(SModel structureModel)

a helper method to get a declaration node for this concept in the case of the legacy concept resolving (by string id)

getReferenceLinks

public Collection<SReferenceLink> getReferenceLinks()

Description copied from interface: SAbstractConcept

Returns all the references this concept has, including inherited

Specified by:

getReferenceLinks in interface SAbstractConcept

hasReference

public boolean hasReference(SReferenceLink r)

getContainmentLinks

public Collection<SContainmentLink> getContainmentLinks()

Description copied from interface: SAbstractConcept

Returns all the links this concept has, including inherited There's no "specialized links" at the compiled language level, all links are "original"

Specified by:

getContainmentLinks in interface SAbstractConcept

hasLink

public boolean hasLink(SContainmentLink l)

hasProperty

public boolean hasProperty(SProperty p)

getProperties

public Collection<SProperty> getProperties()

Description copied from interface: SAbstractConcept

Returns all the properties this concept has, including inherited

Specified by:

getProperties in interface SAbstractConcept

isSubConceptOf

public boolean isSubConceptOf(SAbstractConcept anotherConcept)

Description copied from interface: SAbstractConcept

Either implementing or extending the supplied concept

Specified by:

isSubConceptOf in interface SAbstractConcept

Parameters:

anotherConcept - -- another SAbstractConcept

Returns:

true iff this concept is a subconcept of another concept. if one of the concepts is not valid then false is returned

isSubConceptOfSpecial

protected abstract boolean isSubConceptOfSpecial(@NotNull
                                                 ConceptDescriptor thisDescriptor,
                                                 ConceptDescriptor anotherDescriptor,
                                                 SAbstractConcept anotherConcept)

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface SAbstractConcept

Returns:

true for interfaces and abstract concepts.

getDeclarationNode

@Nullable
@Deprecated
public SNode getDeclarationNode()

Deprecated.

Description copied from interface: SAbstractConcept

Returns the declaration node in case sources for this concept are present in IDE Will be removed after 3.4, use getSourceNode() instead

Specified by:

getDeclarationNode in interface SAbstractConcept

getConceptAlias

@NotNull
public String getConceptAlias()

Specified by:

getConceptAlias in interface SAbstractConcept

getShortDescription

@NotNull
public String getShortDescription()

Specified by:

getShortDescription in interface SAbstractConcept

getHelpUrl

@NotNull
public String getHelpUrl()

Specified by:

getHelpUrl in interface SAbstractConcept

isValid

public final boolean isValid()

Description copied from interface: SAbstractConcept

Returns true if this concept is fully-functional. Typically, user code should not care about this Can return false, for example, if the containing language is absent

Specified by:

isValid in interface SAbstractConcept

Returns:

true iff the underlying descriptor is present

convertProperty

@NotNull
public SProperty convertProperty(String propertyName)

Specified by:

convertProperty in interface ConceptMetaInfoConverter

convertAssociation

@NotNull
public SReferenceLink convertAssociation(String role)

Specified by:

convertAssociation in interface ConceptMetaInfoConverter

convertAggregation

@NotNull
public SContainmentLink convertAggregation(String role)

Specified by:

convertAggregation in interface ConceptMetaInfoConverter

toString

public String toString()

Overrides:

toString in class Object

serialize

public abstract String serialize()

deserialize

public static SAbstractConcept deserialize(String s)