Package jetbrains.mps.smodel.adapter.structure.ref

Class SReferenceLinkAdapter

java.lang.Object

jetbrains.mps.smodel.adapter.structure.ref.SReferenceLinkAdapter

All Implemented Interfaces:

SAbstractLink, SConceptFeature, SElement, SNamedElement, SReferenceLink

Direct Known Subclasses:

InvalidReferenceLink, SReferenceLinkAdapterById

public abstract class SReferenceLinkAdapter
extends Object
implements SReferenceLink

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID_DELIM
protected String	myName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SReferenceLinkAdapter(String name)

Method Summary

Modifier and Type	Method	Description
static SReferenceLinkAdapter	deserialize(String s)
String	getName()	Presentation of the element for an end-user.
abstract SAbstractConcept	getOwner()	Retrieves concept where the feature has been declared.
abstract ReferenceDescriptor	getReferenceDescriptor()
String	getRole()
SScope	getScope(SNode referenceNode)	Builds and returns a scope for this reference in the given context.
SScope	getScope(SNode contextNode, SContainmentLink link, int index)	This method allows to build a scope for the reference before its node has been registered in the repository.
SAbstractConcept	getTargetConcept()	The concept for the nodes that this link points to.
boolean	isMultiple()	Instance nodes can contain more than one target element.
boolean	isOptional()	This link may contain no elements.
boolean	isReference()	True for references, false for containment relationships.
boolean	isValid()
abstract String	serialize()
String	toString()

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.SElement

getLanguage, getSourceNode

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

getDeclarationNode, getRoleName

Field Detail

ID_DELIM

public static final String ID_DELIM

See Also:

Constant Field Values

myName

protected String myName

Constructor Detail

SReferenceLinkAdapter

protected SReferenceLinkAdapter(@NotNull
                                String name)

Method Detail

getName

@NotNull
public String getName()

Description copied from interface: SNamedElement

Presentation of the element for an end-user. Unlike identity, the name is deemed user-friendly and shall not be used for persistence.

Specified by:

getName in interface SNamedElement

Returns:

name of the meta element

getReferenceDescriptor

@Nullable
public abstract ReferenceDescriptor getReferenceDescriptor()

isValid

public boolean isValid()

Specified by:

isValid in interface SConceptFeature

getOwner

@NotNull
public abstract SAbstractConcept getOwner()

Description copied from interface: SConceptFeature

Retrieves concept where the feature has been declared. Note, this concept doesn't necessarily match concept of the node when this feature has been obtained through node's meta-model accessors, instead, the feature may originate from one of concept's ancestors.

Specified by:

getOwner in interface SConceptFeature

Returns:

concept this feature is declared in

getRole

public String getRole()

Specified by:

getRole in interface SAbstractLink

isOptional

public boolean isOptional()

Description copied from interface: SAbstractLink

This link may contain no elements.

Specified by:

isOptional in interface SAbstractLink

getTargetConcept

@NotNull
public SAbstractConcept getTargetConcept()

Description copied from interface: SAbstractLink

The concept for the nodes that this link points to.

Specified by:

getTargetConcept in interface SAbstractLink

isReference

public boolean isReference()

Description copied from interface: SAbstractLink

True for references, false for containment relationships.

Specified by:

isReference in interface SAbstractLink

isMultiple

public boolean isMultiple()

Description copied from interface: SReferenceLink

Instance nodes can contain more than one target element.

Specified by:

isMultiple in interface SAbstractLink

Specified by:

isMultiple in interface SReferenceLink

getScope

public SScope getScope(SNode referenceNode)

Description copied from interface: SReferenceLink

Builds and returns a scope for this reference in the given context.

Specified by:

getScope in interface SReferenceLink

Parameters:

referenceNode - node containing the reference, registered in the repository

getScope

public SScope getScope(SNode contextNode,
                       @Nullable
                       SContainmentLink link,
                       int index)

Description copied from interface: SReferenceLink

This method allows to build a scope for the reference before its node has been registered in the repository.

In this case you must provide the nearest available ancestor node as a context node and the location within it where the reference will be placed.

Example: while typing a new statement in the middle of a statement list, the context menu builds a scope before the statement has been created, in order to offer, among other things, all local variables defined up to this point in code. This is achieved by passing the statement list as a context node, "statement" link as the second parameter and the index of the statement within the statement list as the last parameter.

Specified by:

getScope in interface SReferenceLink

Parameters:

contextNode - the nearest ancestor of the node containing the reference

link - containment link in the contextNode

index - position within the link

toString

public String toString()

Overrides:

toString in class Object

serialize

public abstract String serialize()

deserialize

public static SReferenceLinkAdapter deserialize(String s)