Java API ReferenceClass Hierarchy | All Classes | All Fields and Methods

Package com.ibm.xtools.patterns.framework

The com.ibm.xtools.patterns.framework package provides the base classes that form the patterns framework. The pattern framework is an object-oriented framework that provides support for the base classes that are extended by the standard pattern implementation model that includes the pattern library, the contained patterns, and the pattern parameters. The framework promotes consistency in pattern design. Pattern implementations must subclass the key abstractions in this package to create new patterns.

Class summary
AbstractConfigurationProvides a default inner class and holds a reusable singleton instance of the default for public access.
AbstractConfiguration.DefaultRepresents the default framework configuration class.
AbstractPatternDefinitionRepresents the base abstract pattern definition class.
AbstractPatternDependencyRepresents a dependency between two pattern parameters.
AbstractPatternInstanceExtends the pattern service AbstractPatternInstance abstract class.
AbstractPatternLibraryRepresents the abstract base class to all pattern libraries defined by the framework.
AbstractPatternMetatypeRepresents the superclass to all patterns framework metatypes.
AbstractPatternParameterRepresents the common implementation for a pattern parameter.
AbstractPatternStoreRepresents the abstract pattern store that defines the common set of operations across all persistent stores for patterns, definitions and instances.
AbstractPatternStore.DefinitionRepresents the abstract pattern store definition class that defines the methods necessary to persist and reconstitute persisted pattern definitions.
AbstractPatternStore.InstanceRepresents the abstract pattern store instance class that defines the methods necessary to persist and reconstitute persisted pattern instances.
AbstractPatternStoreFactoryRepresents the abstract factory in an instance of the abstract factory pattern.
ParameterArgumentProvides a default implementation for the AbstractParameterArgument abstract class.
PatternDefinitionUsageRepresents the use of a pattern definition.
PatternDependencyDelegateSpecializes 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.
PatternElementDescriptorRepresents the pattern descriptor class that contains the data that describing pattern entities, such as pattern definitions and pattern parameters.
PatternExpansionStatusRepresents the pattern expansion status class that serves as the return value for expand and updates methods used within the pattern expansion execution path.
PatternIdentityIdentifies a pattern through the owning pattern library, the pattern definition's pattern identity and the given pattern definition version.
PatternMetatypeRepresents the abstract class that is the common implementation for a pattern metatype that represents an EClass in an EMF metamodel.
PatternMultiplicityIndicates the pattern multiplicity.
PatternMultiplicity.BoundQualifierRepresents a type-safe enumeration to be used by the outer class methods.
PatternParameterBehaviorCustomizes the pattern behavior.
PatternParameterDelegateSpecializes the abstract pattern delegate abstract class.
PatternParameterIdentityUniquely identifies a pattern parameter.
PatternParameterMappingRepresents a pattern parameter mapping is used to establish how parameters of one pattern are linked to parameters of another pattern.
PatternParameterMapping.FilterRepresents a filter interface for processing source values and returning target values.
PatternParameterMapping.MapRepresents a callback that provides a narrow interface for mapping between parameters.
PatternParameterMapping.ProviderRepresents a mapping provider class used for callback in pattern definition usage definition.
PatternParameterUsageRepresents a pattern parameter usage is used to wrap the use of a pattern parameter from other parts within the framework.
PatternParameterValueRepresents the pattern parameter value class that is a key abstraction in the framework.
PatternParameterValue.AddedRepresents the state of when a pattern parameter value is added.
PatternParameterValue.Added.ConsumerRepresents the consumer callback interface for the added state.
PatternParameterValue.MaintainedRepresents the state of when a pattern parameter value is maintained.
PatternParameterValue.Maintained.ConsumerRepresents the consumer class for maintained values.
PatternParameterValue.ProposedRepresents the state of when a pattern parameter value is proposed.
PatternParameterValue.RemovedRepresents the state of when a pattern parameter value is removed.
PatternParameterValue.Removed.ConsumerRepresents the consumer class for the removed pattern parameter value class.
PatternParameterValue.ReplacedRepresents the state of when a pattern parameter value is replaced by one or more values.
PatternParameterValue.UnresolvedRepresents the state of when a pattern parameter value is unresolved.
PatternParameterValue.Unresolved.DirectiveRepresents a directive that optionally can be included as an argument with the resolve method.
PatternsFrameworkDebugOptionsRepresents the debug options that are available for use when tracing the patterns framework code.
PatternsFrameworkPluginRepresents the patterns framework plug-in class.
PatternsFrameworkResultProvides a default implementation of the AbstractPatternResult class.
PatternsFrameworkStatusSpecializes Multistatus to provide patterns framework specific constructors and specific behavior for computing messages based on child status.
Exception summary
PatternsFrameworkExceptionThrown 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

To assist you with your code design, refer to the com.ibm.xtools.patterns.framework package, the AbstractPatternParameter class. The AbstractPatternParameter class is the common implementation for a pattern parameter and is used indirectly through another subclass that further specializes this class. The abstract pattern parameter is the primary abstraction at runtime forming the backbone for an extension to take place through parameters, parameter dependencies and delegates. There are hot spots that can be overridden within this class. Most pattern implementations will implement some or most of these hot spots by overriding the hot spots methods. The most frequently implemented hot spots would be the expand and isValid methods. The hot spots methods are available for resolving alternatively specified parameter values and determining validity of these alternatively specified parameter values.

For authoring patterns documentation, tutorials, and samples, see the Authoring patterns topic.


Feedback