IBM Rational Software Modeler
Release 6.0

Package com.ibm.xtools.patterns.framework

Provides the base classes that form the patterns framework.

See:
          Description

Class Summary
AbstractConfiguration The abstract framework configuration class provides a default inner class and holds a reusable singleton instance of the default for public access.
AbstractConfiguration.Default The default framework configuration class, an instance of which is held on to by the outer abstract framework configuration class.
AbstractPatternDefinition This is the base abstract pattern definition class.
AbstractPatternDependency This class represents a dependency between two pattern parameters, the dependent pattern parameter dependent on the dependency parameter.
AbstractPatternInstance This class extends the pattern service AbstractPatternInstance abstract class on the pattern author's behalf.
AbstractPatternInstance.Default The default pattern instance class to use for pattern instances.
AbstractPatternInstance.PatternParameterValueQueue A simple queue implementation that is strongly-typed for pattern parameter values.
AbstractPatternLibrary This class is the abstract base class to all pattern libraries defined by the framework.
AbstractPatternMetatype An abstract pattern metatype is the superclass to all patterns framework metatypes; it should contain the common methods needed to use metatypes.
AbstractPatternParameter This class is the common implementation for a pattern parameter and will typically be used indirectly through another subclass that further specializes this class.
AbstractPatternStore This is the abstract pattern store, which defines the common set of operations across all persistent stores for patterns (definitions and instances).
AbstractPatternStore.Definition The abstract pattern store definition class defines the methods necessary to persist and reconsitute persisted pattern definitions.
AbstractPatternStore.Instance The abstract pattern store instance class defines the methods necessary to persist and reconsitute persisted pattern instances.
AbstractPatternStoreFactory The abstract pattern store factory is the abstract factory in an instance of the abstract factory pattern.
ParameterArgument The ParameterArgument class provides a default implementation for the AbstractParameterArgument abstract class.
PatternDefinitionUsage The pattern definition usage class represents the use of a pattern definition.
PatternDependencyDelegate A pattern dependency delegate specializes an abstract pattern delegate and provides a concrete implementation of a pattern dependency delegate that requires an abstract pattern dependency and a pattern definition usage instance to be constructed.
PatternElementDescriptor The pattern descriptor class contains the data that describes pattern entities such as pattern definitions and pattern parameters.
PatternExpansionStatus The pattern expansion status class serves as the return value for expand and updates methods used within the pattern expansion execution path.
PatternIdentity This class identifies a pattern through the owning pattern library, the pattern definition's pattern identity and the given pattern definition version.
PatternMetatype This abstract class is the common implementation for a pattern metatype that represents an EClass in an EMF metamodel.
PatternMultiplicity Pattern multiplicity is used when indicating multiplicity.
PatternMultiplicity.BoundQualifier A type-safe enumeration to be used by the outer class' methods.
PatternParameterBehavior A pattern's behavior is customized in two ways, one customization method are the framework's hot-spots and these hot-spot methods can be overridden to aggregate or redefine existing isolated behavior.
PatternParameterDelegate The pattern parameter delegate class specializes the abstract pattern delegate abstract class.
PatternParameterIdentity A pattern parameter identity uniquely identifies a parameter and is used to associate pattern parameter code with the appropriate pattern parameter descriptor.
PatternParameterMapping A pattern parameter mapping is used to establish how parameters of one pattern are linked to parameters of another pattern.
PatternParameterMapping.Filter A filter interface for processing source values and returning target values.
PatternParameterMapping.Map Another callback that provides a narrow interface for mapping between parameters.
PatternParameterMapping.Provider A mapping provider class used for callback in pattern definition usage definition.
PatternParameterUsage A pattern parameter usage is used to wrap the use of a pattern parameter from other parts within the framework.
PatternParameterValue The pattern parameter value class is a key abstraction in the framework.
PatternParameterValue.Added The added subclass of pattern parameter value represents the state of when a pattern parameter value is added.
PatternParameterValue.Added.Consumer The consumer callback interface for the added state.
PatternParameterValue.Maintained The maintained subclass of the pattern parameter value represents the state of when a pattern parameter value is maintained (it is the current value, not added or removed).
PatternParameterValue.Maintained.Consumer The consumer class for maintained values.
PatternParameterValue.Proposed The proposed subclass of the pattern parameter value represents the state of when a pattern parameter value is proposed (it is ready for validation but its addition is contingent on the validity of the value.
PatternParameterValue.Removed The removed subclass of the pattern parameter value represents the state of when a pattern parameter value is removed (it has just been removed as a value)
PatternParameterValue.Removed.Consumer The consumer class for the removed pattern parameter value class.
PatternParameterValue.Replaced The Replaced subclass of the pattern parameter value represents the state of when a pattern parameter value is replaced by one or more values.
PatternParameterValue.Unresolved The unresolved subclass of the pattern parameter value represents the state of when a pattern parameter value is unresolved (this state indicates the value is in some alternate form that through a resolve can migrate to another resolved stated such as added).
PatternParameterValue.Unresolved.Directive A directive that optionally can be included as an argument with the resolve method, used to indicate whether creation is allowed or not when resolving values.
PatternsFrameworkDebugOptions The debug options that are available for use when tracing the patterns framework code.
PatternsFrameworkPlugin The patterns framework plug-in class.
PatternsFrameworkResult This class provides a default implementation of the AbstractPatternResult class.
PatternsFrameworkStatus The patterns framework status class specializes Multistatus to provide patterns framework specific constructors and specific behavior for computing messages based on child status.
 

Exception Summary
PatternsFrameworkException This exception is thrown at the implementation boundaries of the patterns framework when an exception is caught or an inconsistency is detected.
 

Package com.ibm.xtools.patterns.framework Description

Provides the base classes that form the patterns framework. Pattern implementations should subclass the key abstractions in this package to create new patterns.

Related Documentation

For overviews, tutorials, examples, guides, and tool documentation, please see:


IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.