DmoMeta (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.persist.orm.DmoMeta

Direct Known Subclasses:

FqlToSqlConverter.CompositeDmoInfo
```
public class DmoMeta
extends java.lang.Object
```
An immutable structure that contains the annotation information on a table and its fields. The data is accessed directly from the annotation objects in order to avoid duplicating the information locally.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DmoMeta.WordIndexData
Word index data.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DmoMeta.WordIndexData` Word index data.

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`afterTable` Caches the `afterTable` attribute from `Table` annotation.
`java.lang.String`	`beforeTable` Caches the `beforeTable` attribute from `Table` annotation.
`java.lang.String`	`category` Caches the `category` attribute from `Table` annotation.
`private java.util.Map<java.lang.String,java.lang.Boolean>`	`computedIndexedProperties` The set of indexed, character columns.
`protected java.util.Map<java.lang.String,java.util.List<Property>>`	`customExtents` The annotation to for the properties corresponding to custom extents.
`private java.util.List<P2JIndex>`	`databaseIndexes` The cached list of indexes (lazy initialized in `getDatabaseIndexes()`).
`boolean`	`dirtyIntraRead` Caches the `dirtyIntraRead` attribute from `Table` annotation.
`boolean`	`dirtyRead` Caches the `dirtyRead` attribute from `Table` annotation.
`protected java.lang.Class<? extends DataModelObject>`	`dmoImplInterface` The interface that will be implemented by `DmoClass` es.
`private java.util.List<Property>`	`existingFieldPropertiesList` The list of field descriptors for this DMO properties, ordered by their id
`private java.util.Map<java.lang.String,P2JField>`	`existingFieldsMap` The map of DMO property names to field descriptors for this DMO metadata.
`private java.util.Map<java.lang.String,java.lang.Integer>`	`extentMap` Map of property names to extents for DMO array properties
`private java.lang.Boolean[]`	`hasComputedColumns` Check if this DMO is going to have computed columns in the underlying database representation
`boolean`	`hasValidation` Caches the `hasValidation` attribute from `Table` annotation.
`private int`	`id` The unique id of this DMO.
`private static java.util.concurrent.atomic.AtomicInteger`	`idSeed` The id generator.
`protected java.lang.Class<? extends DataModelObject>`	`iface` The interface of this DMO.
`protected java.lang.Class<? extends Record>`	`implClass` The implementation class of this DMO.
`protected java.util.List<Index>`	`indexes` The list of indexes of this table.
`private java.util.Map<java.lang.Class<?>,RelationInfo>`	`inverseRelations` Map of all foreign relation descriptors, indexed by local class
`boolean`	`isLikeSequential` Caches the `isLikeSequential` attribute from `Table` annotation.
`private java.util.Map<java.lang.String,java.lang.reflect.Method>`	`legacyGetterMap` Map of property names to getter methods for legacy fields only
`private java.util.Map<java.lang.String,java.lang.reflect.Method>`	`legacySetterMap` Map of property names to setter methods for legacy fields only
`java.lang.String`	`legacyTable` Caches the interned `legacy` attribute from `Table` annotation.
`private static CentralLogger`	`log` Logger
`private java.util.List<Property>`	`mandatoryFields` The cached list of mandatory fields.
`java.lang.String`	`namespacePrefix` Caches the `namespacePrefix` attribute from `Table` annotation.
`java.lang.String`	`namespaceUri` Caches the `namespaceUri` attribute from `Table` annotation.
`private boolean`	`nonExpandedExtents` `true` if this DMO has normalized extents
`java.lang.String`	`normalizedLegacyTable` Caches the interned normalized `legacy` attribute from `Table` annotation.
`boolean`	`noUndo` Caches the `NO-UNDO` attribute from `Table` annotation (TEMP-TABLE specific).
`private java.util.Set<java.lang.String>`	`ooFields` Collects all properties of the record whose fields are `Progress.Lang.Object`-typed.
`private java.util.List<Property>`	`originalProperties` The cached list of original fields / properties (lazy initialized in `getFields`).
`private java.util.Map<java.lang.String,java.lang.reflect.Method>`	`pojoGetterMap` `UnmodifiableMap` of property names to getter methods for simple POJO fields only.
`private java.util.Map<java.lang.String,java.lang.reflect.Method>`	`pojoSetterMap` `UnmodifiableMap` of property names to setter methods for simple POJO fields only.
`private org.apache.commons.lang3.tuple.Pair<Property,PropertyMeta>[]`	`properties` The set of properties and their metadata, indexed by their in-memory positions.
`private java.util.Map<java.lang.reflect.Method,PropertyMeta>`	`propsByGetter` The set of properties mapped by their getters.
`protected java.util.Map<java.lang.String,Property>`	`propsByLegacy` The set of annotations for each declared property, mapped by its legacy name.
`protected java.util.Map<java.lang.String,Property>`	`propsByName` The set of annotations for each declared property, mapped by its FQL property name.
`private java.util.Map<java.lang.reflect.Method,PropertyMeta>`	`propsBySetter` The set of properties mapped by their setters.
`protected RecordMeta`	`recordMeta` The record's runtime-meta data.
`private java.util.Map<java.lang.Class<? extends DataModelObject>,RelationInfo>`	`relations` Map of all foreign relation descriptors, indexed by foreign class.
`java.lang.String`	`schema` Schema name associated with this DMO
`java.lang.String`	`serializeName` Caches the `serializeName` attribute from `Table` annotation.
`private DmoSignature`	`signature` A signature containing information about the DMO structure and field constraints.
`private int`	`sqlFieldCount` Number of physical database fields.
`java.lang.String`	`sqlTable` Caches the `name` attribute (SQL table name) from `Table` annotation.
`protected Table`	`table` The annotation for the table.
`boolean`	`tempTable` Flags DMOs of temporary tables.
`private static java.util.Map<java.lang.Class<? extends BaseDataType>,java.lang.Class<? extends BaseDataType>>`	`toWider` The map used in type-widening operations.
`private java.util.List<java.util.Set<java.lang.String>>`	`uniqueConstraints` The cached list of sets of properties participating in UNIQUES indexes.
`private java.util.ArrayList<java.util.List<Property>>`	`uniqueProps` The cached list of lists of whole property instances participating in UNIQUES indexes.
`java.lang.String`	`xmlNodeName` Caches the `xmlNodeName` attribute from `Table` annotation.

Constructor Summary

Constructors
Constructor and Description
`DmoMeta(java.lang.Class<? extends DataModelObject> dmoImplInterface, java.lang.Class<? extends DataModelObject> iface, Table table)` The constructor initializes the data structure.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Property`	`byLegacyName(java.lang.String legacyField)` Looks up a `Property` by its legacy field name.
`private void`	`computeExistingFields()` Creates, if needed, the existingFieldsMap, map of DMO property names to `P2JField` objects describing the corresponding fields and array of `Property`, existingFieldsPropertyList, holding properties for each DMO field, where the index in array is the id of the property minus 1.
`java.lang.Class<? extends DataModelObject>`	`getAnnotatedInterface()` Obtain the interface that contains the annotations.
`java.util.List<Property>`	`getCustomExtentFieldInfo(java.lang.String propName)` Get the list of denormalized properties associated with this extent DMO property.
`java.util.Iterator<P2JIndex>`	`getDatabaseIndexes()` Get an iterator on all indexes of the DMO.
`java.lang.Class<? extends DataModelObject>`	`getDmoImplInterface()` Obtain the implemented DMO interface.
`P2JField`	`getExistingField(java.lang.String name)` Get the descriptor of a field corresponding with the given DMO property name.
`Property`	`getExistingFieldProperty(int fieldId)` Get the descriptor of a field corresponding with the given DMO field id.
`java.util.Collection<P2JField>`	`getExistingFields()` Get the field descriptors for the table associated with this metadata object.
`private java.util.List<Property>`	`getExistingFieldsList()` Get the list of DMO `Property` objects describing the corresponding fields, creating it first, if necessary.
`private java.util.Map<java.lang.String,P2JField>`	`getExistingFieldsMap()` Get the map of DMO property names to `P2JField` objects describing the corresponding fields, creating it first, if necessary.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getExtentMap()` Get the map of DMO property names to extents for the DMO type associated with this buffer, initializing it first if necessary.
`int`	`getFieldCount(boolean extra)` Obtain the number of fields in the table.
`Property`	`getFieldInfo(java.lang.String propName)` Obtain meta information about a field specified by its property name.
`java.util.Iterator<Property>`	`getFields(boolean extra)` Obtain the list of properties for this DMO.
`int`	`getFieldSize()` Get the number of properties in this DMO.
`int`	`getId()` Obtain the unique `id` of this instance.
`java.lang.Class<? extends Record>`	`getImplementationClass()` Obtain the class that implements the DMO interface.
`int`	`getIndexCount(boolean unique)` Return the number of indices for this table (declared in DMO annotations).
`(package private) RelationInfo`	`getInverseRelation(java.lang.Class<?> local)` Get the relation descriptor for the relation to this object's DMO class from `local`.
`java.util.Map<java.lang.String,java.lang.reflect.Method>`	`getLegacyGetterMap()` Get a map of converted DMO property names to corresponding, legacy, getter methods.
`java.util.Map<java.lang.String,java.lang.reflect.Method>`	`getLegacySetterMap()` Get a map of converted DMO property names to corresponding, legacy, setter methods.
`java.util.List<Property>`	`getMandatoryFields()` Get the list of mandatory fields.
`PropertyMeta`	`getMeta(int k)` Get `PropertyMeta` that correspond to the k-th entry in `data` table of the class implementing this DMO.
`java.util.Set<java.lang.String>`	`getOoFields()` Obtain the set of fields which hold `Progress.Lang.Object` of the record.
`java.util.Map<java.lang.String,java.lang.reflect.Method>`	`getPojoGetterMap()` Get a map of converted DMO property names corresponding to simple, bean getter methods.
`java.util.Map<java.lang.String,java.lang.reflect.Method>`	`getPojoSetterMap()` Get a map of converted DMO property names corresponding to simple, bean setter methods.
`P2JIndex`	`getPrimaryIndex(boolean implicit)` Get the primary index.
`static java.util.List<Property>`	`getPropertiesList(java.lang.Class<? extends DataModelObject> iface, boolean tempTable)` Static getter of properties for a DMO interface.
`Property`	`getProperty(int k)` Get the `Property` that correspond to the k-th entry in `data` table of the class implementing this DMO.
`java.util.Map<java.lang.reflect.Method,PropertyMeta>`	`getPropsByGetterMap()` Returns (after eventually has constructed) the map of getters to `PropertyMeta` map, used to fast-access record copy (bypassing the reflection to retrieve a field's value).
`java.util.Map<java.lang.reflect.Method,PropertyMeta>`	`getPropsBySetterMap()` Returns (after eventually has constructed) the map of setters to `PropertyMeta` map, used by `RecordBuffer$Handler`.
`RecordMeta`	`getRecordMeta()` Get the `RecordMeta` holding the runtime meta information of this table.
`RelationInfo`	`getRelation(java.lang.Class<?> foreign)` Get the relation descriptor for the relation from this object's DMO class to `foreign`.
`java.lang.String`	`getSchema()` Obtain the schema name for the DMO represented by this object.
`private static java.lang.String`	`getSchemaByInterface(java.lang.Class<? extends DataModelObject> dmoIface, boolean temporary)` Return the schema name associated with the given DMO interface.
`DmoSignature`	`getSignature()` Get the structure-based signature for this DMO.
`int`	`getSqlFieldCount()` Retrieve the number of fields which are stored physically in the database table.
`java.lang.String`	`getSqlTableName()` Obtain the name of the SQL table for this DMO.
`java.lang.String`	`getTableDefinition()` Constructs and returns a string containing the P4GL schema definition of the table.
`java.util.List<java.util.Set<java.lang.String>>`	`getUniqueConstraints()` Obtain the the sets of unique constraints for each DMO.
`java.util.ArrayList<java.util.List<Property>>`	`getUniqueConstraintsAsProps()` Obtain the lists of unique constraints for each DMO.
`java.util.Map<java.lang.String,DmoMeta.WordIndexData>`	`getWordTables()` Get word tables' names map by the field name
`java.util.Map<java.lang.String,java.lang.String>`	`getWordTablesByIndexName()` Get word tables' names map by the index name
`boolean`	`hasComputedColumns(boolean includeInvisible)` Check if this DMO has computed columns in the underlying database representation.
`boolean`	`hasNotExpandedExtents()` Check if this DMO has normalized extents.
`java.util.Iterator<RelationInfo>`	`inverseRelations()` Get an iterator on all foreign relation descriptors for the current DMO, which describe relations to this table from another.
`boolean`	`isDirtyRead()` Test whether the table of this DMO was marked as "dirty read", that is, if the DMO should share its dirty data.
`java.lang.Boolean`	`isIndexedIgnoreCase(java.lang.String property)` For a given DMO property which may represent an indexed text column, indicate whether that column is set to ignore case.
`boolean`	`isLeadingIndexComponent(java.lang.String property)` Determine whether the given DMO property represents the leading component of any index on this table.
`boolean`	`isMeta()` Check if DMO corresponds to a meta table.
`boolean`	`isTempTable()` Test whether the DMO belongs to a temp table.
`boolean`	`isVST(MetadataManager.SystemTable systemTable)` Check if DMO corresponds to a specified VST.
`private void`	`processRelations()` Process all relations of this DMO.
`(package private) void`	`putInverseRelation(java.lang.Class<?> local, RelationInfo info)` Add an object which describes a foreign relation to this table from another.
`(package private) void`	`putRelation(java.lang.Class<? extends DataModelObject> foreign, RelationInfo info)` Add an object which describes a foreign relation from this table to another.
`java.util.Iterator<RelationInfo>`	`relations()` Get an iterator on all foreign relation descriptors for the current DMO, which describe relations from this table to another.
`(package private) void`	`setImplClass(java.lang.Class<? extends Record> implClass)` Use the passed `implClass` to extract the property metadata and store locally in an indexed array for fast access.
`java.lang.String`	`toString()` Obtain a short description of this object, usually for debugging.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - log
```
private static final CentralLogger log
```
    Logger
  - idSeed
```
private static final java.util.concurrent.atomic.AtomicInteger idSeed
```
    The id generator. It guarantees that the id of each DmoMeta is unique.
  - table
```
protected final Table table
```
    The annotation for the table.
  - recordMeta
```
protected RecordMeta recordMeta
```
    The record's runtime-meta data.
  - propsByName
```
protected java.util.Map<java.lang.String,Property> propsByName
```
    The set of annotations for each declared property, mapped by its FQL property name.
  - customExtents
```
protected java.util.Map<java.lang.String,java.util.List<Property>> customExtents
```
    The annotation to for the properties corresponding to custom extents. If a property was denormalized, it will not be part of this list.
  - propsByLegacy
```
protected final java.util.Map<java.lang.String,Property> propsByLegacy
```
    The set of annotations for each declared property, mapped by its legacy name.
  - indexes
```
protected java.util.List<Index> indexes
```
    The list of indexes of this table.
  - iface
```
protected final java.lang.Class<? extends DataModelObject> iface
```
    The interface of this DMO.
  - dmoImplInterface
```
protected final java.lang.Class<? extends DataModelObject> dmoImplInterface
```
    The interface that will be implemented by DmoClass es.
  - implClass
```
protected java.lang.Class<? extends Record> implClass
```
    The implementation class of this DMO.
  - existingFieldsMap
```
private volatile java.util.Map<java.lang.String,P2JField> existingFieldsMap
```
    The map of DMO property names to field descriptors for this DMO metadata.
  - existingFieldPropertiesList
```
private volatile java.util.List<Property> existingFieldPropertiesList
```
    The list of field descriptors for this DMO properties, ordered by their id
  - originalProperties
```
private java.util.List<Property> originalProperties
```
    The cached list of original fields / properties (lazy initialized in getFields).
  - databaseIndexes
```
private java.util.List<P2JIndex> databaseIndexes
```
    The cached list of indexes (lazy initialized in getDatabaseIndexes()).
  - propsBySetter
```
private java.util.Map<java.lang.reflect.Method,PropertyMeta> propsBySetter
```
    The set of properties mapped by their setters.
  - propsByGetter
```
private java.util.Map<java.lang.reflect.Method,PropertyMeta> propsByGetter
```
    The set of properties mapped by their getters.
  - uniqueConstraints
```
private java.util.List<java.util.Set<java.lang.String>> uniqueConstraints
```
    The cached list of sets of properties participating in UNIQUES indexes.
  - uniqueProps
```
private java.util.ArrayList<java.util.List<Property>> uniqueProps
```
    The cached list of lists of whole property instances participating in UNIQUES indexes.
  - mandatoryFields
```
private java.util.List<Property> mandatoryFields
```
    The cached list of mandatory fields.
  - computedIndexedProperties
```
private java.util.Map<java.lang.String,java.lang.Boolean> computedIndexedProperties
```
    The set of indexed, character columns. The value is if they are case-sensitive or not.
  - relations
```
private java.util.Map<java.lang.Class<? extends DataModelObject>,RelationInfo> relations
```
    Map of all foreign relation descriptors, indexed by foreign class. It will be initialized at first access.
  - inverseRelations
```
private final java.util.Map<java.lang.Class<?>,RelationInfo> inverseRelations
```
    Map of all foreign relation descriptors, indexed by local class
  - tempTable
```
public final boolean tempTable
```
    Flags DMOs of temporary tables.
  - schema
```
public final java.lang.String schema
```
    Schema name associated with this DMO
  - sqlTable
```
public final java.lang.String sqlTable
```
    Caches the name attribute (SQL table name) from Table annotation.
  - legacyTable
```
public final java.lang.String legacyTable
```
    Caches the interned legacy attribute from Table annotation.
  - normalizedLegacyTable
```
public final java.lang.String normalizedLegacyTable
```
    Caches the interned normalized legacy attribute from Table annotation.
  - afterTable
```
public final java.lang.String afterTable
```
    Caches the afterTable attribute from Table annotation.
  - beforeTable
```
public final java.lang.String beforeTable
```
    Caches the beforeTable attribute from Table annotation.
  - category
```
public final java.lang.String category
```
    Caches the category attribute from Table annotation.
  - dirtyRead
```
public final boolean dirtyRead
```
    Caches the dirtyRead attribute from Table annotation.
  - dirtyIntraRead
```
public final boolean dirtyIntraRead
```
    Caches the dirtyIntraRead attribute from Table annotation.
  - hasValidation
```
public final boolean hasValidation
```
    Caches the hasValidation attribute from Table annotation.
  - isLikeSequential
```
public final boolean isLikeSequential
```
    Caches the isLikeSequential attribute from Table annotation.
  - serializeName
```
public final java.lang.String serializeName
```
    Caches the serializeName attribute from Table annotation.
  - xmlNodeName
```
public final java.lang.String xmlNodeName
```
    Caches the xmlNodeName attribute from Table annotation.
  - namespaceUri
```
public final java.lang.String namespaceUri
```
    Caches the namespaceUri attribute from Table annotation.
  - namespacePrefix
```
public final java.lang.String namespacePrefix
```
    Caches the namespacePrefix attribute from Table annotation.
  - signature
```
private final DmoSignature signature
```
    A signature containing information about the DMO structure and field constraints.
  - noUndo
```
public final boolean noUndo
```
    Caches the NO-UNDO attribute from Table annotation (TEMP-TABLE specific).
  - properties
```
private org.apache.commons.lang3.tuple.Pair<Property,PropertyMeta>[] properties
```
    The set of properties and their metadata, indexed by their in-memory positions.
  - sqlFieldCount
```
private final int sqlFieldCount
```
    Number of physical database fields. This may be different than the number of properties.
  - id
```
private final int id
```
    The unique id of this DMO.
  - ooFields
```
private java.util.Set<java.lang.String> ooFields
```
    Collects all properties of the record whose fields are Progress.Lang.Object-typed. Only makes sense for temp tables. When empty, the OO support (ref-counting) is disabled.
  - pojoGetterMap
```
private java.util.Map<java.lang.String,java.lang.reflect.Method> pojoGetterMap
```
    UnmodifiableMap of property names to getter methods for simple POJO fields only.
  - pojoSetterMap
```
private java.util.Map<java.lang.String,java.lang.reflect.Method> pojoSetterMap
```
    UnmodifiableMap of property names to setter methods for simple POJO fields only.
  - legacyGetterMap
```
private java.util.Map<java.lang.String,java.lang.reflect.Method> legacyGetterMap
```
    Map of property names to getter methods for legacy fields only
  - legacySetterMap
```
private java.util.Map<java.lang.String,java.lang.reflect.Method> legacySetterMap
```
    Map of property names to setter methods for legacy fields only
  - extentMap
```
private java.util.Map<java.lang.String,java.lang.Integer> extentMap
```
    Map of property names to extents for DMO array properties
  - hasComputedColumns
```
private java.lang.Boolean[] hasComputedColumns
```
    Check if this DMO is going to have computed columns in the underlying database representation
  - nonExpandedExtents
```
private boolean nonExpandedExtents
```
    true if this DMO has normalized extents
  - toWider
```
private static final java.util.Map<java.lang.Class<? extends BaseDataType>,java.lang.Class<? extends BaseDataType>> toWider
```
    The map used in type-widening operations.
- Constructor Detail
  - DmoMeta
```
public DmoMeta(java.lang.Class<? extends DataModelObject> dmoImplInterface,
               java.lang.Class<? extends DataModelObject> iface,
               Table table)
```
    The constructor initializes the data structure.
    
    Parameters:
    
    dmoImplInterface - The interface that will be implemented by DmoClass es.
    
    iface - The interface that contains the field declarations and the DMO annotations. It is a parent of dmoImplInterface or dmoImplInterface itself. Its (getter) methods are iterated in order to extract the annotations for the fields.
    
    table - The Table annotation of iface. This is the same value from iface.getAnnotation(Table.class).
- Method Detail
  - getPropertiesList
```
public static java.util.List<Property> getPropertiesList(java.lang.Class<? extends DataModelObject> iface,
                                                         boolean tempTable)
```
    Static getter of properties for a DMO interface.
    
    Parameters:
    
    iface - The class representing a DMO interface.
    
    tempTable - True if this DMO represents a temp table. False otherwise.
    
    Returns:
    
    All the properties of the given DMO interface, plus reserved properties if needed.
  - getSchemaByInterface
```
private static java.lang.String getSchemaByInterface(java.lang.Class<? extends DataModelObject> dmoIface,
                                                     boolean temporary)
```
    Return the schema name associated with the given DMO interface.
    
    Parameters:
    
    dmoIface - A DMO interface; if a temporary DMO, the temp table schema name is returned.
    
    temporary - true if dmoIface represents a legacy temp-table, else false.
    
    Returns:
    
    Schema name for the given interface.
  - getAnnotatedInterface
```
public java.lang.Class<? extends DataModelObject> getAnnotatedInterface()
```
    Obtain the interface that contains the annotations.
    
    Returns:
    
    the interface that contains the annotations.
  - getImplementationClass
```
public java.lang.Class<? extends Record> getImplementationClass()
```
    Obtain the class that implements the DMO interface.
    
    Returns:
    
    the class that implements the DMO interface.
  - getDmoImplInterface
```
public java.lang.Class<? extends DataModelObject> getDmoImplInterface()
```
    Obtain the implemented DMO interface.
    
    Returns:
    
    the implemented DMO interface.
  - getSchema
```
public java.lang.String getSchema()
```
    Obtain the schema name for the DMO represented by this object.
    
    Returns:
    
    Schema name.
  - getId
```
public int getId()
```
    Obtain the unique id of this instance. The id is unique among all databases. The id is usually not the same for multiple runs because the ids are assigned in the order the tables are processed.
    
    Returns:
    
    the unique id of this instance.
  - getRecordMeta
```
public RecordMeta getRecordMeta()
```
    Get the RecordMeta holding the runtime meta information of this table.
    
    Returns:
    
    the RecordMeta holding the runtime meta information of this table.
  - getSqlTableName
```
public java.lang.String getSqlTableName()
```
    Obtain the name of the SQL table for this DMO. For temporary tables representing legacy temp-tables, this name represents the base name. When created, a suffix which is unique at runtime is added to this base name.
    
    Returns:
    
    the name of the SQL table for this DMO.
  - isTempTable
```
public boolean isTempTable()
```
    Test whether the DMO belongs to a temp table.
    
    Returns:
    
    true if the DMO belongs to a temp table.
  - isDirtyRead
```
public boolean isDirtyRead()
```
    Test whether the table of this DMO was marked as "dirty read", that is, if the DMO should share its dirty data.
    
    Returns:
    
    true if the table needs to be tracked by the dirty share manager and was hinted at conversion time with dirty-read XML attribute.
  - getFieldInfo
```
public Property getFieldInfo(java.lang.String propName)
```
    Obtain meta information about a field specified by its property name.
    
    Parameters:
    
    propName - The field's property name.
    
    Returns:
    
    Meta information about propName field if it exists, or null otherwise.
  - getCustomExtentFieldInfo
```
public java.util.List<Property> getCustomExtentFieldInfo(java.lang.String propName)
```
    Get the list of denormalized properties associated with this extent DMO property.
    
    Parameters:
    
    propName - The field's property name.
    
    Returns:
    
    The list of denormalized properties, or null if this is not a denormalized or not a extent property.
  - getFieldSize
```
public int getFieldSize()
```
    Get the number of properties in this DMO.
    
    Returns:
    
    The size of propsByName.
  - byLegacyName
```
public Property byLegacyName(java.lang.String legacyField)
```
    Looks up a Property by its legacy field name.
    
    Parameters:
    
    legacyField - The name of the legacy field.
    
    Returns:
    
    The Property whose legacy name was passed as parameter.
  - getFields
```
public java.util.Iterator<Property> getFields(boolean extra)
```
    Obtain the list of properties for this DMO.
    
    Parameters:
    
    extra - If true the surrogate/hidden properties (id, _multiplex) are also added, otherwise only the original fields are returned.
    
    Returns:
    
    An iterator for list of properties for this DMO.
  - getFieldCount
```
public int getFieldCount(boolean extra)
```
    Obtain the number of fields in the table.
    
    Parameters:
    
    extra - If true, the "hidden" fields are taken into account. Use false to get the number of fields in the original table definition.
    
    Returns:
    
    the number of fields in the table, as described above.
  - getExistingField
```
public P2JField getExistingField(java.lang.String name)
```
    Get the descriptor of a field corresponding with the given DMO property name.
    
    Parameters:
    
    name - DMO property name for the desired field descriptor.
    
    Returns:
    
    Field descriptor.
  - getExistingFieldProperty
```
public Property getExistingFieldProperty(int fieldId)
```
    Get the descriptor of a field corresponding with the given DMO field id.
    
    Parameters:
    
    fieldId - DMO property field id for the desired field descriptor.
    
    Returns:
    
    Field descriptor.
  - getExistingFields
```
public java.util.Collection<P2JField> getExistingFields()
```
    Get the field descriptors for the table associated with this metadata object.
    
    Returns:
    
    Collection of the fields of the target table.
  - isLeadingIndexComponent
```
public boolean isLeadingIndexComponent(java.lang.String property)
```
    Determine whether the given DMO property represents the leading component of any index on this table.
    
    Parameters:
    
    property - DMO property to be tested.
    
    Returns:
    
    true if property is a leading index component; else false.
  - getIndexCount
```
public int getIndexCount(boolean unique)
```
    Return the number of indices for this table (declared in DMO annotations). Depending on the parameter the number of unique or non-unique indices will be returned.
    
    Parameters:
    
    unique - Use true to get the number of unique indices and false to get the number of non-unique indices. To obtain the number of all indices, the called must add the two results.
    
    Returns:
    
    the number of indices, unique or non-unique.
  - getWordTables
```
public java.util.Map<java.lang.String,DmoMeta.WordIndexData> getWordTables()
```
    Get word tables' names map by the field name
    
    Returns:
    
    Word tables' names map by the field name.
  - getWordTablesByIndexName
```
public java.util.Map<java.lang.String,java.lang.String> getWordTablesByIndexName()
```
    Get word tables' names map by the index name
    
    Returns:
    
    Word tables' names map by the index name.
  - getDatabaseIndexes
```
public java.util.Iterator<P2JIndex> getDatabaseIndexes()
```
    Get an iterator on all indexes of the DMO. The resulting iterator returns P2JIndex objects, each of which defines the columns participating in an index.
    
    Returns:
    
    Iterator on index definition objects.
  - getPrimaryIndex
```
public P2JIndex getPrimaryIndex(boolean implicit)
```
    Get the primary index. If a PRIMARY index is found it is returned. If no index was declared PRIMARY and implicit == false the method returns false. If implicit == true, the first declared index is returned. If the table does not define any fields, null is returned.
    
    Parameters:
    
    implicit - If true, if there is no explicit primary index, the first index is returned as being the implicit primary index. Otherwise, in the event there is no primary index declared, the method returns null.
    
    Returns:
    
    The PRIMARY index, the primary IMPLICIT index or null as described above.
  - getMandatoryFields
```
public java.util.List<Property> getMandatoryFields()
```
    Get the list of mandatory fields.
    
    Returns:
    
    The mandatoryFields.
  - isIndexedIgnoreCase
```
public java.lang.Boolean isIndexedIgnoreCase(java.lang.String property)
```
    For a given DMO property which may represent an indexed text column, indicate whether that column is set to ignore case.
    
    Parameters:
    
    property - DMO property name.
    
    Returns:
    
    true to ignore case, false to preserve case sensitivity, null if the property does not represent an indexed text column.
  - getUniqueConstraints
```
public java.util.List<java.util.Set<java.lang.String>> getUniqueConstraints()
```
    Obtain the the sets of unique constraints for each DMO. That is, the set of index components for each unique index for this DMO. Uses lazy initialization, the list for each DMO is computed at first access.
    
    Returns:
    
    list of sets of properties participating in UNIQUES indexes.
  - getUniqueConstraintsAsProps
```
public java.util.ArrayList<java.util.List<Property>> getUniqueConstraintsAsProps()
```
    Obtain the lists of unique constraints for each DMO. That is, the list of index components for each unique index for this DMO. Uses lazy initialization, the list for each DMO is computed at first access.
    
    Returns:
    
    list of lists of whole property instances participating in UNIQUES indexes.
  - getProperty
```
public Property getProperty(int k)
```
    Get the Property that correspond to the k-th entry in data table of the class implementing this DMO.
    
    Parameters:
    
    k - The index of the property.
    
    Returns:
    
    the k-th Property.
  - getMeta
```
public PropertyMeta getMeta(int k)
```
    Get PropertyMeta that correspond to the k-th entry in data table of the class implementing this DMO.
    
    Parameters:
    
    k - The index of the property.
    
    Returns:
    
    the k-th Property.
  - getRelation
```
public RelationInfo getRelation(java.lang.Class<?> foreign)
```
    Get the relation descriptor for the relation from this object's DMO class to foreign.
    
    Parameters:
    
    foreign - DMO interface for the foreign table.
    
    Returns:
    
    Relation descriptor or null if this DMO has no foreign key relation with foreign.
  - getPojoGetterMap
```
public java.util.Map<java.lang.String,java.lang.reflect.Method> getPojoGetterMap()
```
    Get a map of converted DMO property names corresponding to simple, bean getter methods.
    
    Returns:
    
    Map as described above.
  - getPojoSetterMap
```
public java.util.Map<java.lang.String,java.lang.reflect.Method> getPojoSetterMap()
```
    Get a map of converted DMO property names corresponding to simple, bean setter methods.
    
    Returns:
    
    Map as described above.
  - getOoFields
```
public java.util.Set<java.lang.String> getOoFields()
```
    Obtain the set of fields which hold Progress.Lang.Object of the record. This only makes sense for temp-tables. When empty, the OO support (ref-counting) is disabled.
    
    Returns:
    
    An unmodifiable set of Progress.Lang.Object fields of the table.
  - getLegacyGetterMap
```
public java.util.Map<java.lang.String,java.lang.reflect.Method> getLegacyGetterMap()
```
    Get a map of converted DMO property names to corresponding, legacy, getter methods. Legacy methods include simple bean getters for scalar fields, and an indexed getter which takes a simple int parameter as the subscript value for extent fields. Even if an extent field has been denormalized, the latter is provided for backward compatibility, as some runtime code may not have been converted to use the denormalized methods directly.
    
    Returns:
    
    Map as described above.
  - getLegacySetterMap
```
public java.util.Map<java.lang.String,java.lang.reflect.Method> getLegacySetterMap()
```
    Get a map of converted DMO property names to corresponding, legacy, setter methods. Legacy methods include simple bean setters for scalar fields, and an indexed setter which takes a simple int parameter as the subscript value for extent fields. Even if an extent field has been denormalized, the latter is provided for backward compatibility, as some runtime code may not have been converted to use the denormalized methods directly.
    
    Returns:
    
    Map as described above.
  - getExtentMap
```
public java.util.Map<java.lang.String,java.lang.Integer> getExtentMap()
```
    Get the map of DMO property names to extents for the DMO type associated with this buffer, initializing it first if necessary.
    
    Returns:
    
    Map of DMO array properties to extents.
  - setImplClass
```
void setImplClass(java.lang.Class<? extends Record> implClass)
           throws java.lang.IllegalAccessException,
                  java.lang.NoSuchFieldException
```
    Use the passed implClass to extract the property metadata and store locally in an indexed array for fast access. The indexed array contain both the Property annotation and the PropertyMeta data paired so they can be accessed using getProperty(int) and getMeta(int) methods respectively.
    
    Parameters:
    
    implClass - The implementation class to be processed for extraction of property metadata.
    
    Throws:
    
    java.lang.IllegalAccessException - when the implClass cannot be accessed via reflection.
    
    java.lang.NoSuchFieldException - when the implClass cannot be accessed via reflection.
  - putRelation
```
void putRelation(java.lang.Class<? extends DataModelObject> foreign,
                 RelationInfo info)
```
    Add an object which describes a foreign relation from this table to another.
    
    Parameters:
    
    foreign - DMO interface for the foreign table.
    
    info - Relation descriptor.
  - relations
```
public java.util.Iterator<RelationInfo> relations()
```
    Get an iterator on all foreign relation descriptors for the current DMO, which describe relations from this table to another.
    
    Returns:
    
    Iterator on RelationInfo objects.
  - getInverseRelation
```
RelationInfo getInverseRelation(java.lang.Class<?> local)
```
    Get the relation descriptor for the relation to this object's DMO class from local.
    
    Parameters:
    
    local - DMO interface for the local table.
    
    Returns:
    
    Relation descriptor or null if this DMO has no inverse foreign key relation with local.
  - putInverseRelation
```
void putInverseRelation(java.lang.Class<?> local,
                        RelationInfo info)
```
    Add an object which describes a foreign relation to this table from another.
    
    Parameters:
    
    local - DMO interface for the local table.
    
    info - Relation descriptor.
  - inverseRelations
```
public java.util.Iterator<RelationInfo> inverseRelations()
```
    Get an iterator on all foreign relation descriptors for the current DMO, which describe relations to this table from another.
    
    Returns:
    
    Iterator on RelationInfo objects.
  - processRelations
```
private void processRelations()
```
    Process all relations of this DMO. Store them locally and their inverse into the foreign DMO.
  - getPropsByGetterMap
```
public java.util.Map<java.lang.reflect.Method,PropertyMeta> getPropsByGetterMap()
```
    Returns (after eventually has constructed) the map of getters to PropertyMeta map, used to fast-access record copy (bypassing the reflection to retrieve a field's value).
    
    Returns:
    
    the map of getters to PropertyMeta map.
  - getPropsBySetterMap
```
public java.util.Map<java.lang.reflect.Method,PropertyMeta> getPropsBySetterMap()
```
    Returns (after eventually has constructed) the map of setters to PropertyMeta map, used by RecordBuffer$Handler.
    
    Returns:
    
    the map of setters to PropertyMeta map.
  - getSignature
```
public DmoSignature getSignature()
```
    Get the structure-based signature for this DMO.
    
    Returns:
    
    The signature of this DMO.
  - toString
```
public java.lang.String toString()
```
    Obtain a short description of this object, usually for debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a short description of this object.
  - getTableDefinition
```
public java.lang.String getTableDefinition()
```
    Constructs and returns a string containing the P4GL schema definition of the table. The result is not cached so this method is to be used only for debug.
    
    Returns:
    
    a string containing the P4GL legacy schema definition of the table.
  - isMeta
```
public boolean isMeta()
```
    Check if DMO corresponds to a meta table.
    
    Returns:
    
    true if DMO corresponds to a meta table..
  - isVST
```
public boolean isVST(MetadataManager.SystemTable systemTable)
```
    Check if DMO corresponds to a specified VST.
    
    Parameters:
    
    systemTable - VST to be checked
    
    Returns:
    
    true if DMO corresponds to a specified VST.
  - getSqlFieldCount
```
public int getSqlFieldCount()
```
    Retrieve the number of fields which are stored physically in the database table. This may not equal the number of properties, as some data types require two SQL fields (i.e. datetime-tz).
    
    Returns:
    
    The number of fields which are generated in the database table for this model.
  - hasComputedColumns
```
public boolean hasComputedColumns(boolean includeInvisible)
```
    Check if this DMO has computed columns in the underlying database representation. This is used mostly for temporary tables and may not be completely compatible with persistent tables.
    
    Parameters:
    
    includeInvisible - true to include the columns which are defined as invisible in the underlying database. Invisible columns are the ones which are not implicitly retrieved using SELECT * or direct access.
    
    Returns:
    
    true if we also have other columns that the legacy ones in the database.
  - computeExistingFields
```
private void computeExistingFields()
```
    Creates, if needed, the existingFieldsMap, map of DMO property names to P2JField objects describing the corresponding fields and array of Property, existingFieldsPropertyList, holding properties for each DMO field, where the index in array is the id of the property minus 1.
  - hasNotExpandedExtents
```
public boolean hasNotExpandedExtents()
```
    Check if this DMO has normalized extents. These should be loaded separately.
    
    Returns:
    
    true if the DMO has non-expanded extents (kept in a separate SQL table).
  - getExistingFieldsMap
```
private java.util.Map<java.lang.String,P2JField> getExistingFieldsMap()
```
    Get the map of DMO property names to P2JField objects describing the corresponding fields, creating it first, if necessary.
    
    Returns:
    
    Map of property names to field descriptors.
  - getExistingFieldsList
```
private java.util.List<Property> getExistingFieldsList()
```
    Get the list of DMO Property objects describing the corresponding fields, creating it first, if necessary.
    
    Returns:
    
    List of field descriptors, ordered by their id and each index corresponds the objects id.

Class DmoMeta

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

idSeed

table

recordMeta

propsByName

customExtents

propsByLegacy

indexes

iface

dmoImplInterface

implClass

existingFieldsMap

existingFieldPropertiesList

originalProperties

databaseIndexes

propsBySetter

propsByGetter

uniqueConstraints

uniqueProps

mandatoryFields

computedIndexedProperties

relations

inverseRelations

tempTable

schema

sqlTable

legacyTable

normalizedLegacyTable

afterTable

beforeTable

category

dirtyRead

dirtyIntraRead

hasValidation

isLikeSequential

serializeName

xmlNodeName

namespaceUri

namespacePrefix

signature

noUndo

properties

sqlFieldCount

id

ooFields

pojoGetterMap

pojoSetterMap

legacyGetterMap

legacySetterMap

extentMap

hasComputedColumns

nonExpandedExtents

toWider

Constructor Detail

DmoMeta

Method Detail

getPropertiesList

getSchemaByInterface

getAnnotatedInterface

getImplementationClass

getDmoImplInterface

getSchema

getId

getRecordMeta

getSqlTableName

isTempTable

isDirtyRead

getFieldInfo

getCustomExtentFieldInfo

getFieldSize

byLegacyName

getFields

getFieldCount