com.goldencode.p2j.persist.meta

Class MetadataManager

java.lang.Object

com.goldencode.p2j.persist.meta.MetadataManager

public final class MetadataManager
extends java.lang.Object

This class creates, prepares, and populates the embedded database(s) used to serve metadata information to converted business logic and to the persistence framework. All methods are static; the class is never instantiated. Most methods are only called during server startup. The isMetaDMO(Class) method, however, is meant to be used by callers who need to determine whether a particular DMO interface is metadata-related.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataManager.Category System table categories
private static class	MetadataManager.FileTableRecordBuilder _File table record field/value map builder.
private static class	MetadataManager.Helper Helper class for calling DMO setter methods when populating a metaschema record.
private static class	MetadataManager.MapBuilder<T extends MetadataManager.MapBuilder<T>> Map<String, Object> fluent builder.
static class	MetadataManager.SystemTable System tables (as of Progress 11.6.3)
private static interface	MetadataManager.TableFlags System tables' flags

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_CONNECT Constant used to identify the _Connect meta table.
static java.lang.String	_DB Constant used to identify the _Db meta table.
static java.lang.String	_FIELD Constant used to identify the _Field meta table.
static java.lang.String	_FILE Constant used to identify the _File meta table.
static java.lang.String	_INDEX Constant used to identify the _Index meta table.
static java.lang.String	_INDEX_FIELD Constant used to identify the _Index meta table.
static java.lang.String	_LOCK Constant used to identify the _Lock meta table.
static java.lang.String	_MYCONNECTION Constant used to identify the _MyConnection meta table.
static java.lang.String	_TRANS Constant used to identify the _Trans meta table.
static java.lang.String	_USER Constant used to identify the _User meta table.
static java.lang.String	_USERTABLESTAT Constant used to identify the _UserTableStat meta table.
private static java.lang.String	baseDir Base directory for DMO resources in jar file
private static java.util.Set<java.lang.String>	CHAR_TYPES Character field types
private static java.util.Map<Database,Database>	coreDatabases Map that stores the core database for a tenant database.
private static int	DB_RECID The recid of the database in _Db table.
static java.lang.String	DDL_INDEX Well-known name of DDL script to create indexes
static java.lang.String	DDL_TABLE Well-known name of DDL script to create tables
private static java.util.Set<java.lang.Class<? extends DataModelObject>>	dmoMetaTypes Set of DMO interfaces which are metadata DMOs
private static java.util.Map<java.lang.String,java.lang.Integer>	DTYPE Map of data type names to associated _Field._dtype value
private static java.util.Map<java.lang.String,java.lang.String>	FETCH_TYPE Map of data type names to associated _Field._fetch-type value
private static java.util.concurrent.ConcurrentMap<Database,java.util.concurrent.ConcurrentMap<java.lang.Class<?>,integer>>	FILE_NUM _File._File_num values for the primary databases
private static java.util.concurrent.ConcurrentMap<Database,java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.Integer>>	FILE_NUM_BY_TBL_NAME _File._File_num values for the primary databases by table name
private static java.util.Map<java.lang.String,MetadataManager.Helper>	helpers Map of short meta DMO names to helper objects
private static boolean	inUse Stores the status of the metadata server.
private static CentralLogger	log Logger
private static boolean	LOG_INFO Do we log INFO-level events ?
private static boolean	LOG_WARNING Do we log WARNING-level events ?
static java.lang.String	META_PREFIX Well-known prefix of metadata DMOs
static java.lang.String	META_SCHEMA Well-known name of metadata schema
private static java.util.concurrent.ConcurrentMap<Database,java.util.concurrent.ConcurrentMap<java.lang.String,java.util.concurrent.atomic.AtomicLong>>	TABLE_IDS _File table ID generator
private static java.util.Map<java.lang.Class<? extends Record>,java.lang.Long>	templateRecords Cached the template records (_file._template values) for fast access.
private static java.util.concurrent.ConcurrentMap<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,DmoMeta.WordIndexData>>>	WORD_TABLES Word tables' names for the primary databases

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MetadataManager() Private constructor; this class is not instantiated.

Method Summary

Modifier and Type	Method and Description
static void	addDynamicTableToFile(Database primaryDb, java.lang.String dmoName) Adds the details of a dynamic permanent table to meta tables.
private static void	addFilelist(Persistence p, MetadataManager.Helper h, int fileListId, int fileListSize, int fileListExtend, int fileListLogicalSz, int fileListBlkSize, java.lang.String fileListOpenmode, java.lang.String fileListName) Sets a single _Filelist metatable data.
private static boolean	addMetaTableToFile(Database metaDb, MetadataManager.Helper fileHelper, java.lang.Class<? extends DataModelObject> dmoIface, java.lang.Class<? extends Record> dmoImpl, Persistence p) Add record for a table from the meta database to the _File table.
private static void	addTableToFile(Database primary, Database meta, java.lang.String dmoName, MetadataManager.Helper fileHelper, Persistence p) Add record for a table from the primary database to the _File table.
private static java.util.Map<MetadataManager.SystemTable,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>>	childData(Database metaDb, java.lang.Class<? extends DataModelObject> dmoIface, int _file_num, integer pk) Collect child metadata for a record in the _File meta table.
private static void	createDbMetaRecord(Database database, Persistence p) Creates and saves a record in MetaDb table with the given recId.
private static void	deleteRecord(java.sql.Connection conn, long p, java.lang.String sql, java.lang.String what) Executes a specific delete statement and optionally log the result using the logger's configuration.
private static void	executeDDLScript(Database database, java.sql.Connection connection, java.lang.String script) Execute a script containing DDL SQL statements.
private static java.util.Map<java.lang.String,java.lang.Object>	fieldData(Database metaDb, int _file_num, Property property, java.lang.Class<?> ftype, java.util.Map<java.lang.String,integer> fieldRecidByName, java.util.Map<java.lang.String,integer> fieldRposByName) Collect _Field table data for a DMO field.
static integer	getFileNum(Database db, java.lang.Class<?> dmoImpl) Get _File._File_num value for the table
static java.lang.Integer	getFileNum(Database db, java.lang.String tableName) Get _File._File_num value for the table
private static MetadataManager.Helper	getHelper(java.lang.String type) Gets the metadata helper for a specified table.
private static java.lang.String	getShortName(java.lang.String tableName) Calculate short DMO interface name for a table.
static java.lang.Long	getTemplateRowid(java.lang.Class<?> table) Return the rowid of the template record for a permanent table.
static DmoMeta.WordIndexData	getWordTableName(java.lang.String dbName, java.lang.String tableName, java.lang.String fieldName) Get the word index data.
private static void	indexData(Database metaDb, java.lang.String tblDmoName, int _file_num, java.util.Iterator<P2JIndex> indices, integer pk, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> indexes, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> indexFields, java.util.Map<java.lang.String,integer> fieldRecidByName) Collect index metadata for a record in the _File meta table.
static boolean	initialize() Initialize this class and start up a secure database server to allow remote P2J servers to access metadata.
static boolean	inUse() Checks the status of the metadata subsystem.
static boolean	inUse(java.lang.String meta) Checks the status of one of the tables of the metadata subsystem.
static boolean	isMetaDMO(java.lang.Class<? extends DataModelObject> dmoIface) Indicate whether the given DMO interface represents a metaschema table.
private static long	nextId(Database metaDb, java.lang.String table) Return record id for table in the meta database.
private static void	populateArea(Database database, Persistence p) Populates the _Area meta table with initial values.
static void	populateDatabase(Database metaDb) Populate the specified, embedded database with metaschema information read from DMO interface annotations.
private static void	populateDatabaseFeatures(Database database, Persistence p) Populates the _Database-Feature meta table with initial values.
private static void	populateFilelist(Database database, Persistence p) Populates the _Filelist meta table with initial values.
private static void	populateFileTable(Database database, Persistence p) Populates the _File meta table with initial values.
private static void	populateSequence(Database metaDb, Persistence p) Populates the _Sequence meta table with initial values.
private static void	populateStartupTable(Database database, Persistence p) Populates the _Startup meta table with an initial record.
private static void	populateTenant(Database database, Persistence p) Populates the _Tenant meta table with initial values.
private static void	populateTransTable(Database database, Persistence p) Populates the _Trans meta table with an initial record.
static void	prepareDatabase(Database database) Create and load the embedded metadata database for the associated primary database.
private static void	registerWordTables(DmoMeta dmoMeta) Register word tables for a master table.
static void	removeDynamicTable(Database primaryDb, DmoMeta dmoMeta) Removes a registered dynamic permanent table from this manager.
static void	reset(Database primaryDB, Database metaDB) Reset in-memory metadata.
private static void	saveChildren(Persistence p, java.util.Map<MetadataManager.SystemTable,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> children) Save child metadata (_Field, _Index, _Index-Field, ...
private static void	setArea(Persistence p, MetadataManager.Helper h, int areaVersion, int areaNumber, java.lang.String areaName, int areaType, int areaBlock, int areaAttrib, int areaClustersize, int areaBlocksize, int areaRecbits, int areaExtents) Sets a single _Area metatable data.
private static void	setDatabaseFeature(Persistence p, MetadataManager.Helper h, int featureId, java.lang.String featureName, boolean isActive, boolean isEnabled) Sets a single database feature.
private static void	setMetaTableRecord(Persistence p, MetadataManager.Helper h, java.util.Map<java.lang.String,java.lang.Object> values) Created a new meta-table record using the helper constructor, populates it with the values passed in the map and save it to (meta) database.
static void	setupIdentityManager(Database database, Dialect dialect) Set up sequence identity mManager for this database by creating the fresh instance of p2j_id_generator_sequence.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

META_SCHEMA

public static final java.lang.String META_SCHEMA

Well-known name of metadata schema

See Also:

Constant Field Values

META_PREFIX

public static final java.lang.String META_PREFIX

Well-known prefix of metadata DMOs

See Also:

Constant Field Values

DDL_TABLE

public static final java.lang.String DDL_TABLE

Well-known name of DDL script to create tables

See Also:

Constant Field Values

DDL_INDEX

public static final java.lang.String DDL_INDEX

Well-known name of DDL script to create indexes

See Also:

Constant Field Values

_FILE

public static final java.lang.String _FILE

Constant used to identify the _File meta table. Used a key in helpers.

See Also:

Constant Field Values

_DB

public static final java.lang.String _DB

Constant used to identify the _Db meta table. Used a key in helpers.

See Also:

Constant Field Values

_LOCK

public static final java.lang.String _LOCK

Constant used to identify the _Lock meta table. Used a key in helpers.

See Also:

Constant Field Values

_MYCONNECTION

public static final java.lang.String _MYCONNECTION

Constant used to identify the _MyConnection meta table. Used a key in helpers.

See Also:

Constant Field Values

_CONNECT

public static final java.lang.String _CONNECT

Constant used to identify the _Connect meta table. Used a key in helpers.

See Also:

Constant Field Values

_TRANS

public static final java.lang.String _TRANS

Constant used to identify the _Trans meta table. Used a key in helpers.

See Also:

Constant Field Values

_INDEX

public static final java.lang.String _INDEX

Constant used to identify the _Index meta table. Used a key in helpers.

See Also:

Constant Field Values

_INDEX_FIELD

public static final java.lang.String _INDEX_FIELD

Constant used to identify the _Index meta table. Used a key in helpers.

See Also:

Constant Field Values

_FIELD

public static final java.lang.String _FIELD

Constant used to identify the _Field meta table. Used a key in helpers.

See Also:

Constant Field Values

_USERTABLESTAT

public static final java.lang.String _USERTABLESTAT

Constant used to identify the _UserTableStat meta table. Used a key in helpers.

See Also:

Constant Field Values

_USER

public static final java.lang.String _USER

Constant used to identify the _User meta table. Used a key in helpers.

See Also:

Constant Field Values

log

private static final CentralLogger log

Logger

LOG_WARNING

private static final boolean LOG_WARNING

Do we log WARNING-level events ?

LOG_INFO

private static final boolean LOG_INFO

Do we log INFO-level events ?

DB_RECID

private static final int DB_RECID

The recid of the database in _Db table.

See Also:

Constant Field Values

DTYPE

private static final java.util.Map<java.lang.String,java.lang.Integer> DTYPE

Map of data type names to associated _Field._dtype value

FETCH_TYPE

private static final java.util.Map<java.lang.String,java.lang.String> FETCH_TYPE

Map of data type names to associated _Field._fetch-type value

CHAR_TYPES

private static final java.util.Set<java.lang.String> CHAR_TYPES

Character field types

helpers

private static final java.util.Map<java.lang.String,MetadataManager.Helper> helpers

Map of short meta DMO names to helper objects

coreDatabases

private static final java.util.Map<Database,Database> coreDatabases

Map that stores the core database for a tenant database.

dmoMetaTypes

private static final java.util.Set<java.lang.Class<? extends DataModelObject>> dmoMetaTypes

Set of DMO interfaces which are metadata DMOs

baseDir

private static final java.lang.String baseDir

Base directory for DMO resources in jar file

inUse

private static boolean inUse

Stores the status of the metadata server.

templateRecords

private static final java.util.Map<java.lang.Class<? extends Record>,java.lang.Long> templateRecords

Cached the template records (_file._template values) for fast access. The keys are the DMO implementation classes of the tables from permanent database. The values are the rowid values as Long data.

TABLE_IDS

private static final java.util.concurrent.ConcurrentMap<Database,java.util.concurrent.ConcurrentMap<java.lang.String,java.util.concurrent.atomic.AtomicLong>> TABLE_IDS

_File table ID generator

FILE_NUM

private static final java.util.concurrent.ConcurrentMap<Database,java.util.concurrent.ConcurrentMap<java.lang.Class<?>,integer>> FILE_NUM

_File._File_num values for the primary databases

FILE_NUM_BY_TBL_NAME

private static final java.util.concurrent.ConcurrentMap<Database,java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.Integer>> FILE_NUM_BY_TBL_NAME

_File._File_num values for the primary databases by table name

WORD_TABLES

private static final java.util.concurrent.ConcurrentMap<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,DmoMeta.WordIndexData>>> WORD_TABLES

Word tables' names for the primary databases

Constructor Detail

MetadataManager

private MetadataManager()

Private constructor; this class is not instantiated.

Method Detail

reset

public static void reset(Database primaryDB,
                         Database metaDB)

Reset in-memory metadata.

Parameters:

primaryDB - primary database

metaDB - meta database

isMetaDMO

public static boolean isMetaDMO(java.lang.Class<? extends DataModelObject> dmoIface)

Indicate whether the given DMO interface represents a metaschema table.

Parameters:

dmoIface - DMO interface to test.

Returns:

true if dmoIface represents a metaschema table, else false.

getFileNum

public static integer getFileNum(Database db,
                                 java.lang.Class<?> dmoImpl)

Get _File._File_num value for the table

Parameters:

db - primary db

dmoImpl - Table DMO class

Returns:

_File._File_num value for the table

getFileNum

public static java.lang.Integer getFileNum(Database db,
                                           java.lang.String tableName)

Get _File._File_num value for the table

Parameters:

db - primary db

tableName - Table nbame

Returns:

_File._File_num value for the table

initialize

public static boolean initialize()
                          throws PersistenceException

Initialize this class and start up a secure database server to allow remote P2J servers to access metadata.

Returns:

true if the metadata manager was initialized; false if there are no metadata classes found.

Throws:

PersistenceException - if there is any error initializing the class or starting the server.

inUse

public static boolean inUse(java.lang.String meta)

Checks the status of one of the tables of the metadata subsystem. Note that this method returns true from the moment the initialize() has finished with success. At that moment the whole metadata system is not yet ready as the metadata tables are not yet populated.

Use this method to check if the project was not configured with this feature or if metadata initialization failed, and quickly leave the calling method in these cases. If this method returns false it means that:

• metadata was completely disabled from server configuration; or
• the specified table was not added to metadata block in static config file; or
• the DMO for the specified _meta table was not converted, not found in classpath or failed to load and register as a standard DMO interface.

Parameters:

meta - The short name (see _<name> constants in this class) of a metadata table.

Returns:

true if the MetadataManager was successfully initialized, queries on internal data are possible and the specified meta table is active in the current configuration. Returns false if the initialization failed, the metadata is not "in use" or the specified table does not appear in the metadata block of the current config file.

inUse

public static boolean inUse()

Checks the status of the metadata subsystem. Note that this method returns true from the moment the initialize() has finished with success. At that moment the whole metadata system is not yet ready as the metadata tables are not yet populated.

Use this method to check if the project was not configured with this feature or if metadata initialization failed, and quickly leave the calling method in these cases.

Returns:

true if the MetadataManager was successfully initialized and queries on internal data are possible and false if the initialization failed and the metadata is not "in use".

prepareDatabase

public static void prepareDatabase(Database database)
                            throws PersistenceException

Create and load the embedded metadata database for the associated primary database. start up a secure database server to allow remote P2J servers to access this metadata.

Parameters:

database - Database information object.

Throws:

PersistenceException - if there is any error creating or loading the database.

setupIdentityManager

public static void setupIdentityManager(Database database,
                                        Dialect dialect)
                                 throws PersistenceException

Set up sequence identity mManager for this database by creating the fresh instance of p2j_id_generator_sequence. Because it is repopulated at each startup the start value of the sequence is not crucial; the value is hardcoded to 10000.

Parameters:

database - The database to set up the identity manager for.

dialect - The dialect for the database. It is used to build the DDL for the sequence create statement.

Throws:

PersistenceException - if something goes wrong with database connection.

populateDatabase

public static void populateDatabase(Database metaDb)
                             throws PersistenceException

Populate the specified, embedded database with metaschema information read from DMO interface annotations.

Parameters:

metaDb - Metaschema database to populate.

Throws:

PersistenceException - if there is any problem reading the DMO annotations, instantiating DMO instances, or inserting records into the database.

getWordTableName

public static DmoMeta.WordIndexData getWordTableName(java.lang.String dbName,
                                                     java.lang.String tableName,
                                                     java.lang.String fieldName)

Get the word index data.

Parameters:

dbName - Database name.

tableName - Master table name.

fieldName - Field name.

Returns:

The word index data.

addDynamicTableToFile

public static void addDynamicTableToFile(Database primaryDb,
                                         java.lang.String dmoName)

Adds the details of a dynamic permanent table to meta tables.

Parameters:

primaryDb - The primary database where the table belongs to.

dmoName - The DMO of the dynamic table.

removeDynamicTable

public static void removeDynamicTable(Database primaryDb,
                                      DmoMeta dmoMeta)

Removes a registered dynamic permanent table from this manager.

Parameters:

primaryDb - The primary database

dmoMeta - The meta information of the table to be removed.

deleteRecord

private static void deleteRecord(java.sql.Connection conn,
                                 long p,
                                 java.lang.String sql,
                                 java.lang.String what)
                          throws java.sql.SQLException

Executes a specific delete statement and optionally log the result using the logger's configuration.

Parameters:

conn - The Connection to database.

sql - The SQL statement to be executed.

p - The unique long parameter which identifies the records to be deleted.

what - Used only when logging is enabled, additional information on what is deleted.

Throws:

java.sql.SQLException - If the statement failed to be executed.

populateFileTable

private static void populateFileTable(Database database,
                                      Persistence p)

Populates the _File meta table with initial values.

Parameters:

database - The database structure whose features need to be added to _Database-Feature table.

p - The Persistence that manages the database.

addTableToFile

private static void addTableToFile(Database primary,
                                   Database meta,
                                   java.lang.String dmoName,
                                   MetadataManager.Helper fileHelper,
                                   Persistence p)

Add record for a table from the primary database to the _File table.

Parameters:

primary - primary database

meta - meta database

dmoName - table DMO interface

fileHelper - _File table helper

p - Persistence for the meta database

registerWordTables

private static void registerWordTables(DmoMeta dmoMeta)

Register word tables for a master table.

Parameters:

dmoMeta - DmoMeta for master table

addMetaTableToFile

private static boolean addMetaTableToFile(Database metaDb,
                                          MetadataManager.Helper fileHelper,
                                          java.lang.Class<? extends DataModelObject> dmoIface,
                                          java.lang.Class<? extends Record> dmoImpl,
                                          Persistence p)

Add record for a table from the meta database to the _File table.

Parameters:

metaDb - meta database

fileHelper - _File table helper

dmoIface - table DMO interface

dmoImpl - table DMO

p - Persistence for the meta database.

Returns:

true if successful

saveChildren

private static void saveChildren(Persistence p,
                                 java.util.Map<MetadataManager.SystemTable,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> children)

Save child metadata (_Field, _Index, _Index-Field, ... ) of the table.

Parameters:

p - Persistence for the meta database

children - child metadata

populateSequence

private static void populateSequence(Database metaDb,
                                     Persistence p)

Populates the _Sequence meta table with initial values. These are specific to FWD implementation, specific to backing database server or may be set manually in a configuration file.

Parameters:

metaDb - The database structure whose features need to be added to _Database-Feature table.

p - The Persistence that manages the database.

populateDatabaseFeatures

private static void populateDatabaseFeatures(Database database,
                                             Persistence p)

Populates the _Database-Feature meta table with initial values. These are specific to FWD implementation, specific to backing database server or may be set manually in a configuration file.

Parameters:

database - The database structure whose features need to be added to _Database-Feature table.

p - The Persistence that manages the database.

createDbMetaRecord

private static void createDbMetaRecord(Database database,
                                       Persistence p)

Creates and saves a record in MetaDb table with the given recId.

Parameters:

database - The database to be processed.

p - The persistence context to be used when saving.

populateArea

private static void populateArea(Database database,
                                 Persistence p)

Populates the _Area meta table with initial values. This is a "mock" since _Area data has no meaningful counterparts in FWD

Parameters:

database - The database structure whose features need to be added to _Area table.

p - The Persistence that manages the database.

populateFilelist

private static void populateFilelist(Database database,
                                     Persistence p)

Populates the _Filelist meta table with initial values. This is a "mock" since _Filelist data has no meaningful counterparts in FWD

Parameters:

database - The database structure whose features need to be added to _Area table.

p - The Persistence that manages the database.

populateStartupTable

private static void populateStartupTable(Database database,
                                         Persistence p)

Populates the _Startup meta table with an initial record.

Parameters:

database - The database.

p - The Persistence that manages the database.

populateTransTable

private static void populateTransTable(Database database,
                                       Persistence p)

Populates the _Trans meta table with an initial record.

Parameters:

database - The database.

p - The Persistence that manages the database.

populateTenant

private static void populateTenant(Database database,
                                   Persistence p)

Populates the _Tenant meta table with initial values. This is a "mock" since _Tenant data has no meaningful counterparts in FWD

Parameters:

database - The database structure whose features need to be added to _Area table.

p - The Persistence that manages the database.

setDatabaseFeature

private static void setDatabaseFeature(Persistence p,
                                       MetadataManager.Helper h,
                                       int featureId,
                                       java.lang.String featureName,
                                       boolean isActive,
                                       boolean isEnabled)

Sets a single database feature. Only the id, name and active/enabled status are set, the reserved fields are ignored.

Parameters:

p - Persistence instance for the table

h - The helper to be used.

featureId - The id of the feature to be set.

featureName - The name of the feature to be set.

isActive - Whether the feature is active at startup.

isEnabled - Whether the feature is enabled at startup.

setArea

private static void setArea(Persistence p,
                            MetadataManager.Helper h,
                            int areaVersion,
                            int areaNumber,
                            java.lang.String areaName,
                            int areaType,
                            int areaBlock,
                            int areaAttrib,
                            int areaClustersize,
                            int areaBlocksize,
                            int areaRecbits,
                            int areaExtents)

Sets a single _Area metatable data. _Area-misc field is not populated

Parameters:

p - Persistence instance for the table

h - The helper to be used.

areaVersion - area version

areaNumber - area number

areaName - area name

areaType - area type

areaBlock - area block

areaAttrib - area attributes

areaClustersize - area cluster size

areaBlocksize - area block size

areaRecbits - area recbits (rows per block = 2 ^ recbits)

areaExtents - area extents

addFilelist

private static void addFilelist(Persistence p,
                                MetadataManager.Helper h,
                                int fileListId,
                                int fileListSize,
                                int fileListExtend,
                                int fileListLogicalSz,
                                int fileListBlkSize,
                                java.lang.String fileListOpenmode,
                                java.lang.String fileListName)

Sets a single _Filelist metatable data. _FileList-Misc field is not populated

Parameters:

p - Persistence instance for the table

h - The helper to be used.

fileListId - fileList id

fileListSize - fileList size

fileListExtend - fileList extend

fileListLogicalSz - fileList logical size

fileListBlkSize - fileList block size

fileListOpenmode - fileList open mode

fileListName - fileList name

setMetaTableRecord

private static void setMetaTableRecord(Persistence p,
                                       MetadataManager.Helper h,
                                       java.util.Map<java.lang.String,java.lang.Object> values)

Created a new meta-table record using the helper constructor, populates it with the values passed in the map and save it to (meta) database.

Parameters:

p - Persistence instance for the table

h - The helper to be used.

values - The record fields' values

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

java.lang.reflect.InvocationTargetException

java.lang.IllegalArgumentException

PersistenceException

getTemplateRowid

public static java.lang.Long getTemplateRowid(java.lang.Class<?> table)

Return the rowid of the template record for a permanent table.

Parameters:

table - The permanent table to lookup.

Returns:

The value of the rowid of the template record. If metadata is not enabled for this project or _file metatable is not configured or table is an invalid name null is returned.

getHelper

private static MetadataManager.Helper getHelper(java.lang.String type)

Gets the metadata helper for a specified table. In case such helper is not found, the event is logged with WARNING level and null is returned.

Parameters:

type - The name of meta file.

Returns:

The helper corresponding to type, or null if no support such table was set up.

executeDDLScript

private static void executeDDLScript(Database database,
                                     java.sql.Connection connection,
                                     java.lang.String script)
                              throws PersistenceException

Execute a script containing DDL SQL statements.

Parameters:

database - Target database.

connection - Connection to target database.

script - Short name of script file, which is expected to be found in the application jar file. The following path is implied:

          {base DMO package}._meta.{script name}
          

Throws:

PersistenceException - if there is any error connecting to the target database or executing the DDL statements.

getShortName

private static java.lang.String getShortName(java.lang.String tableName)

Calculate short DMO interface name for a table.

Parameters:

tableName - The table name.

Returns:

short DMO interface name

nextId

private static long nextId(Database metaDb,
                           java.lang.String table)

Return record id for table in the meta database.

Parameters:

metaDb - meta database

table - meta table

Returns:

record id for table in the meta database

childData

private static java.util.Map<MetadataManager.SystemTable,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> childData(Database metaDb,
                                                                                                                                     java.lang.Class<? extends DataModelObject> dmoIface,
                                                                                                                                     int _file_num,
                                                                                                                                     integer pk)

Collect child metadata for a record in the _File meta table.

Parameters:

metaDb - meta database

dmoIface - table DMO interface

_file_num - _File._file_num field value

pk - table primary key id in the _Index table holder

Returns:

child metadata for a record in the _File meta table.

indexData

private static void indexData(Database metaDb,
                              java.lang.String tblDmoName,
                              int _file_num,
                              java.util.Iterator<P2JIndex> indices,
                              integer pk,
                              java.util.List<java.util.Map<java.lang.String,java.lang.Object>> indexes,
                              java.util.List<java.util.Map<java.lang.String,java.lang.Object>> indexFields,
                              java.util.Map<java.lang.String,integer> fieldRecidByName)

Collect index metadata for a record in the _File meta table.

Parameters:

metaDb - meta database

tblDmoName - table DMO

_file_num - _File._file_num field value

indices - P2JIndex iterator

pk - table primary key id in the _Index table holder

indexes - table indexes metadata

indexFields - table index fields metadata

fieldRecidByName - Map of property names to their recid.

fieldData

private static java.util.Map<java.lang.String,java.lang.Object> fieldData(Database metaDb,
                                                                          int _file_num,
                                                                          Property property,
                                                                          java.lang.Class<?> ftype,
                                                                          java.util.Map<java.lang.String,integer> fieldRecidByName,
                                                                          java.util.Map<java.lang.String,integer> fieldRposByName)

Collect _Field table data for a DMO field.

Parameters:

metaDb - meta database

_file_num - _File._file_num field value

property - Property annotation of the field.

fieldRecidByName - Fields' record id by property name map.

fieldRposByName - Fields' (r)pos id by property name map.

Returns:

_Field table data for a DMO field.