|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.xtools.patterns.framework.PatternParameterUsage
A pattern parameter usage is used to wrap the use of a pattern parameter from other parts within the framework. This typically means that a parameter descriptor or some related information on that parameter descriptor needs to be proxified so that the parameter descriptor is resolved only after the first time it is needed. This is done not for performance reasons but for the reason of eliminating re-entrant calls into the constructor of the particular abstract pattern library being initialized when the first pattern service interrogation calls come in to the framework. There is an equivalent of this class for pattern definitions that is used for the same purpose (as well as being used for nested pattern instances).
Field Summary |
Fields inherited from interface com.ibm.xtools.patterns.core.IParameterDescriptor |
BINDABLE |
Fields inherited from interface com.ibm.xtools.transform.core.ITransformationDescriptor |
AUTHOR, DESCRIPTION, DOCUMENT, EXTENSIBLE, GROUP_PATH, GROUP_PATH_DELIMITERS, ICON, ID, KEYWORDS, KEYWORDS_DELIMITERS, NAME, PROFILES, PROFILES_DELIMITERS, PROVIDER, PUBLIC, SOURCE_MODEL_TYPE, SOURCE_MODEL_TYPE_DELIMITERS, TARGET_MODEL_TYPE, TARGET_MODEL_TYPE_DELIMITERS, TRANSFORM_GUI, VERSION |
Method Summary | |
int |
compareTo(Object o)
|
IPatternMetatype[] |
getAlternateTypes()
Retrieves the alternate types that are accepted for the arguments of the parameter represented by this descriptor. |
String |
getDescription()
Retrieve the localized description of the transformation item. |
String |
getId()
Retrieve the unique id of the transformation item. |
IMultiplicity |
getMultiplicity()
Retrieves the multiplicity of the parameter represented by this descriptor. |
String |
getName()
Retrieve the localized name of the transformation item. |
int |
getOrdinal()
Retrieves the ordinal of the parameter in the list of parameters for the pattern. |
IPatternIdentity |
getPatternIdentity()
Retrieves the composite identity of the pattern that has the parameter represented by this descriptor. |
ITransformationProperty[] |
getProperties()
Return all defined properties associated with this transformation. |
ITransformationProperty |
getProperty(String propertyId)
Return the specified property associated with this transformation. |
String[] |
getPropertyIds()
List the identifers of properties associated with this transformation. |
IPatternMetatype |
getType()
Retrieves the type of the parameter represented by this descriptor. |
boolean |
isBindable()
Retrieves whether the parameter represented by this descriptor is available for binding with an argument or arguments. |
boolean |
isPublic()
Return true if the transformation is public (visible in UI). |
boolean |
isValidArgumentType(IPatternMetatype metatype)
Checks whether the object of the given metatype is accepted as an argument of the parameter represented by this descriptor. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public int compareTo(Object o)
compareTo
in interface Comparable
public IPatternMetatype[] getAlternateTypes()
IParameterDescriptor
Retrieves the alternate types that are accepted for the arguments of the parameter represented by this descriptor.
getAlternateTypes
in interface IParameterDescriptor
public String getDescription()
ITransformationItem
getDescription
in interface ITransformationItem
public String getId()
ITransformationItem
getId
in interface ITransformationItem
public IMultiplicity getMultiplicity()
IParameterDescriptor
Retrieves the multiplicity of the parameter represented by this descriptor.
Multiplicity represents the range of the allowable cardinality values that a set can assume.
getMultiplicity
in interface IParameterDescriptor
public String getName()
ITransformationItem
getName
in interface ITransformationItem
public int getOrdinal()
IParameterDescriptor
Retrieves the ordinal of the parameter in the list of parameters for the pattern.
getOrdinal
in interface IParameterDescriptor
public IPatternIdentity getPatternIdentity()
IParameterDescriptor
Retrieves the composite identity of the pattern that has the parameter represented by this descriptor.
The composite unique identity of a pattern is represented by a pattern descriptor. The components of the identity are the id (getPatternId) and the version of the pattern (getPatternVersion).
getPatternIdentity
in interface IParameterDescriptor
public ITransformationProperty[] getProperties()
ITransformationDescriptor
getProperties
in interface ITransformationDescriptor
public ITransformationProperty getProperty(String propertyId)
ITransformationDescriptor
getProperty
in interface ITransformationDescriptor
propertyId
- the identifier of the property
public String[] getPropertyIds()
ITransformationDescriptor
getPropertyIds
in interface ITransformationDescriptor
public IPatternMetatype getType()
IParameterDescriptor
Retrieves the type of the parameter represented by this descriptor.
Use the Pair method to retrieve the argument pairs used as parameter arguments. Use the isValidArgumentType method to retrieve whether the object of a specific metatype is accepted as an argument of the parameter. Use the getAlternateTypes method to retrieve the types accepted for parameter arguments.
getType
in interface IParameterDescriptor
public boolean isBindable()
IParameterDescriptor
Retrieves whether the parameter represented by this descriptor is available for binding with an argument or arguments.
A binding is a relationship connection between a template and a model element generated from the template. It provides the collection of the arguments that instantiate the template parameters. A binding is associated with one template. Each binding generates one model element. The generated model element must be fully specified by the arguments supplied to the binding.
Note: In general, if a parameter is not bindable, it should not be exposed to a user.
isBindable
in interface IParameterDescriptor
public boolean isPublic()
ITransformationDescriptor
This is a convenience method for returning the value of the PUBLIC property.
isPublic
in interface ITransformationDescriptor
public boolean isValidArgumentType(IPatternMetatype metatype)
IParameterDescriptor
Checks whether the object of the given metatype is accepted as an argument of the parameter represented by this descriptor.
Use the getAlternateTypes method to retrieve the types accepted for parameter arguments.
isValidArgumentType
in interface IParameterDescriptor
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.