de.interactive_instruments.ShapeChange.Model.EA
Class OperationInfoEA

java.lang.Object
  extended by de.interactive_instruments.ShapeChange.Model.InfoImpl
      extended by de.interactive_instruments.ShapeChange.Model.OperationInfoImpl
          extended by de.interactive_instruments.ShapeChange.Model.EA.OperationInfoEA
All Implemented Interfaces:
Info, OperationInfo

public class OperationInfoEA
extends OperationInfoImpl
implements OperationInfo


Field Summary
protected  ClassInfoEA classInfo
          Class the operation belongs to
protected  EADocument document
          Access to the document object
protected  org.sparx.Method eaMethod
          EA method object
protected  String eaName
          Name of the operation
protected  String eaOperationId
          Model-unique id.
protected  org.sparx.Collection<org.sparx.Parameter> eaParametersCache
          Cache map for Parameters
protected  HashSet<String> stereotypesCache
          Cache set for stereotypes
protected  HashMap<String,String> taggedValuesCache
          Cache map for tagged values
protected  ClassInfoEA typeClassInfo
           
protected  Type typeInfo
          Type information
 
Fields inherited from class de.interactive_instruments.ShapeChange.Model.InfoImpl
aliasName, definition, description, documentation
 
Constructor Summary
OperationInfoEA(EADocument doc, ClassInfoEA ci, org.sparx.Method meth)
          Create an OperationInfo object given an EA Method.
 
Method Summary
 String aliasName()
          Get alias name of the property.
 String id()
          Return model-unique id of operation.
 Model model()
          Return EA model object.
 String name()
          Obtain the name of the property.
 Options options()
          Return options and configuration object.
 int parameterCount()
          Return the total number of parameters including __RETURN__
 TreeMap<Integer,String> parameterNames()
          Obtain the names all parameters of the operation.
 TreeMap<Integer,String> parameterTypes()
          Obtain the types of all parameters of the operation.
 ShapeChangeResult result()
          Return result object for error reporting.
 Set<String> stereotypes()
          Return the normalized stereotype of the operation.
 String taggedValue(String tag)
          Return the tagged value for the tag given or null if missing.
 HashMap<String,String> taggedValues()
           
 HashMap<String,String> taggedValues(String tagList)
          Return all the tagged values listed in the input string.
 
Methods inherited from class de.interactive_instruments.ShapeChange.Model.OperationInfoImpl
fullName, postprocessAfterLoadingAndValidate
 
Methods inherited from class de.interactive_instruments.ShapeChange.Model.InfoImpl
definition, description, documentation, encodingRule, matches, stereotype
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface de.interactive_instruments.ShapeChange.Model.Info
definition, description, documentation, encodingRule, fullName, matches, postprocessAfterLoadingAndValidate, stereotype
 

Field Detail

document

protected EADocument document
Access to the document object


classInfo

protected ClassInfoEA classInfo
Class the operation belongs to


eaOperationId

protected String eaOperationId
Model-unique id. This is the ID from EA Methods, prefixed by the class ID.


eaName

protected String eaName
Name of the operation


typeInfo

protected Type typeInfo
Type information


typeClassInfo

protected ClassInfoEA typeClassInfo

eaMethod

protected org.sparx.Method eaMethod
EA method object


stereotypesCache

protected HashSet<String> stereotypesCache
Cache set for stereotypes


taggedValuesCache

protected HashMap<String,String> taggedValuesCache
Cache map for tagged values


eaParametersCache

protected org.sparx.Collection<org.sparx.Parameter> eaParametersCache
Cache map for Parameters

Constructor Detail

OperationInfoEA

public OperationInfoEA(EADocument doc,
                       ClassInfoEA ci,
                       org.sparx.Method meth)
Create an OperationInfo object given an EA Method.

Method Detail

parameterCount

public int parameterCount()
Return the total number of parameters including __RETURN__

Specified by:
parameterCount in interface OperationInfo

parameterNames

public TreeMap<Integer,String> parameterNames()
Obtain the names all parameters of the operation. They will appear ordered as in the method definition. The return value (if any) appears in the last position and the receives the name __RETURN__.

Specified by:
parameterNames in interface OperationInfo

parameterTypes

public TreeMap<Integer,String> parameterTypes()
Obtain the types of all parameters of the operation. Types will appear ordered as in the method definition. The type of the return value (if any) appears in the last position.

Specified by:
parameterTypes in interface OperationInfo

id

public String id()
Return model-unique id of operation.

Specified by:
id in interface Info

model

public Model model()
Return EA model object.

Specified by:
model in interface Info

name

public String name()
Obtain the name of the property.

Specified by:
name in interface Info

aliasName

public String aliasName()
Get alias name of the property.

Specified by:
aliasName in interface Info
Overrides:
aliasName in class InfoImpl
Returns:
the human readable name or an empty string if none exists

options

public Options options()
Return options and configuration object.

Specified by:
options in interface Info

result

public ShapeChangeResult result()
Return result object for error reporting.

Specified by:
result in interface Info

stereotypes

public Set<String> stereotypes()
Return the normalized stereotype of the operation.

Specified by:
stereotypes in interface Info

taggedValue

public String taggedValue(String tag)
Return the tagged value for the tag given or null if missing.

Specified by:
taggedValue in interface Info
Parameters:
tag - name of the tagged value to look up
Returns:
the tagged value for the tag given or null if the tagged value is missing.

taggedValues

public HashMap<String,String> taggedValues(String tagList)
Return all the tagged values listed in the input string. Tags are assumed to be separated by commas.

Specified by:
taggedValues in interface Info

taggedValues

public HashMap<String,String> taggedValues()
Specified by:
taggedValues in interface Info
Returns:
a map with the tagged values defined for this object (key: tagged value name, value: the value of the tagged value); can be an empty map but not null
See Also:
Info.taggedValues()


Copyright © 2015. All rights reserved.