Package wt.eff.format

Provides classes and interfaces for handling formats for effectivity statements.

See:
Description

Interface Summary

EffFormat	General Documentation: This interface and its supporting implementations provide the capability of specifying formats, the effectivity statements follow.
EffFormatRetrievalStrategy	This interface is designed to encapsulate the various means (algorithms) for the retrieval of effectivity format given some state information, representing a Strategy design pattern.
EffFormatService	EffFormatService accepts "messages" that are of interest to Effectivity Format classes.

Class Summary

AbstractEffFormat	This abstract class implements the EffFormat interface and is designed to hold any common implementation that could be potentially shared across all sub-classes, but also available for extension if need be.
AlphaNumericUnitEffFormat	This format supports fixed-length effectivity statements with an optional prefix, a fixed-length numeric portion (with a max.
DefaultUnitEffFormat	This format represents the default format for unit effectivity statements if no other effectivity format is supplied and thus acts like a placeholder.
EffFormatDetails	A class that is designed to hold the details of a particular format as specified in the configuration resource used (defaults to a windchill preference).
EffFormatFactory	A factory class designed to create and maintain instances of EffFormat classes.
EffFormatHelper	Supported API: true Extendable: false
EffRangeValues	A class that represents an immutable Value Object - designed to hold start and end range values of effectivity statements.
EffState	A class that is designed to hold the state associated while processing one or many effectivity statements.
NumericUnitEffFormat	This format supports fixed-length (max.
PreferenceBasedRetrieval	This implementation queries container-based preferences to query the corresponding effectivity format, given some state information.
StandardEffFormatService	Standard implementation of the EffFormatService interface.
UnitEffFormat	UnitEffFormat class is the parent of all concrete Unit Number Effectivity Format classes.

Exception Summary

EffFormatException

Provides an abstraction of an abnormal occurrence or error resulting while an effectivity format related operation is executed.

Package wt.eff.format Description

Provides classes and interfaces for handling formats for effectivity statements. Effectivity formats provided by this package are designed to be extendable / customizable. Thus a customizer can either override either part of an existing format implementation or provide a complete implementation of all methods as part of the EffFormat interface.

Introduction: This packagae consists of a small framework that defines and formalizes the concept of an effectivity format and the operations associated with it. In general, it provides a hook in the effectivity processing business logic that delegates format-related operations to the format framework instead of making decisions based on its assumptions. (Date formats are part of the framework for consistency reasons, but they are not intended to be targets of customizations).

A traceable part’s unit effectivity format is stored as an attribute on the WTPartMaster (think of it as meta-data), and it is recorded on the part’s creation. Thus, every traceable part knows its associated effectivity format, which will be used for format related operations on that part, like validation. Individual part iterations inherit its associated format from its master.

This framework allows for “extending” an existing unit format. This is the recommended approach, if you just want to change some of the behavior of the out-of-the-box effectivity formats. For example: You just want to change the validation logic for the Alpha-Numeric Format.

If that does not solve your needs, then they can define a new format, providing your logic for all the supported operations and you do not need a separate modelling tool to provide a customization.

Note: Instances of Effectivty format classes do not have any persistable state and hence do not have corresponding database tables. Formats exist simply to provide the business logic for the related business operations.

Default Format: The Defualt Unit Format is the default unit format if no other format is specified. See the JavaDoc for wt.eff.format.DefaultUnitEffFormat for more information.

Customization Help: A brief description of this framework along with its capabilities and some examples of customizations is provided in the Customizer's Guide.