Package org.melati.poem.prepro

A Maven plugin to run the POEM Preprocessor.

See:
Description

Interface Summary

Generator

An interface which defines a process method on a Writer.

Class Summary

AtomFieldDef	The definition of all base fields.
BigDecimalFieldDef	A definition of a BigDecimalPoemType from the DSD.
BinaryFieldDef	A definition of a BinaryPoemType from the DSD.
BooleanFieldDef	A definition of a BooleanPoemType from the DSD.
CacheSizeTableQualifier	A TableQualifier which defines the size of the cache for a Table.
CategoryTableQualifier	A TableQualifier which defines the Category of a Table.
ColumnTypeFieldDef	A definition of a ColumnTypePoemType.
CompareOnlyFieldQualifier	A FieldQualifier which defines whether a Field is a CompareOnly field.
DateFieldDef	A definition of a DatePoemType from the DSD.
DeletedFieldQualifier	A FieldQualifier which defines whether a Field is a DeletedField.
DescriptionFieldQualifier	A FieldQualifier which defines the Description of a Field.
DescriptionTableQualifier	A TableQualifier which defines the Description of a Table.
DisplayLevelFieldDef	A definition of a DisplayLevelPoemType from the DSD.
DisplayLevelFieldQualifier	A FieldQualifier which defines the DisplayLevel of a Field.
DisplayNameFieldQualifier	A FieldQualifier which defines the DisplayName of a Field.
DisplayNameTableQualifier	A TableQualifier which defines the DisplayName of a Table.
DisplayOrderFieldQualifier	A FieldQualifier which defines the DisplayOrder of a Field.
DisplayOrderPriorityFieldQualifier	A FieldQualifier which defines the DisplayOrderPriority of a Field.
DisplayOrderTableQualifier	A TableQualifier which defines the DisplayOrder of a Table.
DoubleFieldDef	A definition of a DoublePoemType from the DSD.
DSD	The DSD class is an application which parses a DSD (Data Structure Definition) file and outputs Java code, creating a POEM view of a database.
FieldDef	An abstract definition of a Field from which all other FieldDefs are derived.
FieldQualifier	Abstract class from which all FieldQualifiers are derived.
HeightFieldQualifier	A FieldQualifier which defines the Height of a Field.
IndexedFieldQualifier	A FieldQualifier which defines whether a Field is Indexed.
IntegerFieldDef	A definition of an IntegerPoemType from the DSD.
IntegrityFixFieldDef	A definition of an IntegrityFixPoemType from the DSD.
IntegrityfixFieldQualifier	A FieldQualifier which defines the type of IntegrityFix to use with a reference field.
LongFieldDef	A definition of an LongPoemType from the DSD.
MelatiDsdProcessorMojo	Process a DSD file.
NullableFieldQualifier	A FieldQualifier which defines whether a Field is Nullable.
PasswordFieldDef	A definition of a PasswordPoemType from the DSD.
PrecisionFieldQualifier	A FieldQualifier which enables the precision of BigDecimals to be specified.
ReferenceFieldDef	A definition of a ReferencePoemType from the DSD.
RenderinfoFieldQualifier	A FieldQualifier which defines the which templet to use to render the field.
ScaleFieldQualifier	A FieldQualifier which enables the scale of BigDecimals to be specified.
SearchabilityFieldDef	A definition of a SearchabilityPoemType from the DSD.
SearchabilityFieldQualifier	A FieldQualifier which defines the type of Searchability a Field has.
SeqCachedTableQualifier	A TableQualifier which defines whether the sequence of records in a Table is cached.
SizeFieldQualifier	A FieldQualifier which enables the size of strings to be specified.
SortDescendingFieldQualifier	A FieldQualifier which defines whether a Field is sorted in descending order.
StringFieldDef	A definition of a StringPoemType from the DSD.
StringUtils	An assortment of useful operations on Strings.
TableDef	A Table Definition holding information from a DSD.
TableNamingInfo	A store for Table Name information extracted from the DSD.
TableNamingStore	A store of naming information for a Table.
TableQualifier	Abstract class from which all TableQualifiers are derived.
TimestampFieldDef	A definition of a TimestampPoemType from the DSD.
TroidFieldQualifier	A FieldQualifier which defines whether a Field is a TroidField.
UncreateableFieldQualifier	A FieldQualifier which defines whether a Field is Uncreatable.
UneditableFieldQualifier	A FieldQualifier which defines whether a Field is Unedittable.
UniqueFieldQualifier	A FieldQualifier which defines whether a Field is Unique.
WidthFieldQualifier	A FieldQualifier which defines the Width of a Field .

Exception Summary

IntegrityfixFieldQualifier.ApplicationException	Thrown when an attempt is made to apply an IntegrityFix to a field which is not a ReferencePoemType.
SizeApplicationException	Thrown when a SizeFieldQualifier is applied to an inappropriate field.

Package org.melati.poem.prepro Description

A Maven plugin to run the POEM Preprocessor.

POEM DSD processor for generating support classes from a DSD.

The processor is a commandline application which uses the native java tokeniser to parse a Data Structure Definition file.

The required imports are stored until the whole file has been parsed so enabling forward references within the DSD.