com.goldencode.p2j.schema

Class SchemaConfig

java.lang.Object

com.goldencode.p2j.schema.SchemaConfig

public final class SchemaConfig
extends java.lang.Object

Schema configuration information. This class is instantiated by the master Configuration reading input data from an XML configuration file. The syntax of that XML file is specified external to this class. The purpose of this class is to store and provide access to the configuration. How that configuration is read is not of concern here.

Each database used by an application is configured in an XML element in the configuration file. That element contains a short name or handle for the database, which matches the logical name of the database. It also contains a path to the DF file exported from the Progress data dictionary (the import file from our perspective), as well as the XML file to which the imported schema information will be written for use in conversion (the schema file). Finally, a database can be a default database (always loaded into the schema dictionary when parsing source code), or non-default (only loaded on demand by the Progress parser). All of this information about a particular database is encoded in an instance of the NsConfig inner class (which is public since the external configuration reading process must create instances of it). Those NsConfig instances are then added using addNamespace(com.goldencode.p2j.schema.SchemaConfig.NsConfig).

One database is designated the "metadata" database. This is the database which contains metadata about the schema structure used to define all databases in Progress (for a specific version of Progress). The tables and fields of this database are referenced in source code as if they were members of every other logical database. Thus, the schema information included in the metadata database schema is merged with each logical database as it is loaded into the schema dictionary. The metadata schema configuration is accessible via the getMetadata() method.

See Also:

SchemaLoader, SchemaDictionary

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaConfig.Metadata Encapsulates information about the project's use of database metadata, including the name of the metadata schema and the metadata tables used by the application, if any.
static class	SchemaConfig.NsConfig Encapsulates information about a namespace configuration, including name, XML file, and whether namespace should be loaded into the schema dictionary by default.
private static class	SchemaConfig.Profile An immutable structure which holds information about a single configuration profile.

Field Summary

Fields

Modifier and Type	Field and Description
private SchemaConfig.Profile	defaultProfile This is the default profile when the configuration is queried.
private static boolean	developerModeWarned Flag used for simplify the log by avoiding multiple messages for trying developing mode search.
private static ConversionStatus	LOG Logger for objects of this type.
private SchemaConfig.Metadata	metadata Name of metadata definition applied to every loaded schema
private java.lang.String	primaryKeyName Primary key name, hardcoded the same as Session.DEFAULT_PK
private java.util.Map<java.lang.String,SchemaConfig.Profile>	profiles Map of database names to namespace configuration data.
private SchemaConfig.Profile	unnamedProfile This is the unnamed profile.

Constructor Summary

Constructors

Constructor and Description
SchemaConfig() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addNamespace(SchemaConfig.NsConfig cfg) Add a namespace configuration object to the default profile configuration.
void	addProfile(ProfileConfig config) Add a profile object to this configuration.
java.util.Iterator<java.lang.String>	databases() Get an iterator for the configured database names of default profile.
java.util.Iterator<java.lang.String>	databases(boolean active) Get an iterator for the configured database names of all activated profiles.
java.util.Iterator<java.lang.String>	databases(java.lang.String profile) Get an iterator for the configured database names of the requested profile.
void	deactiveDefaults() Deactivate all default profiles, as we are running in multi-profile mode.
java.util.Iterator<java.lang.String>	defaultDatabases() Get an iterator of names of those databases which have been configured as default schemas for namespace lookup purposes.
java.util.Iterator<java.lang.String>	defaultDatabases(java.lang.String profile) Get an iterator of names of those databases which have been configured as default schemas for namespace lookup purposes.
private SchemaConfig.Profile	getDefaultProfile() Returns the default profile.
java.io.File	getImportFile(java.lang.String nsName) Returns a file object representing the import (DF) file associated with the specified database schema name of the default profile.
java.io.File	getImportFile(java.lang.String profile, java.lang.String nsName) Returns a file object representing the import (DF) file associated with the specified database schema name in a specific profile.
SchemaConfig.Metadata	getMetadata() Get the metadata identifier name associated with all schemas.
java.lang.String	getNamespaceParameter(java.lang.String name, java.lang.String param) Get the value for the given namespace parameter in the default profile.
java.lang.String	getNamespaceParameter(java.lang.String profile, java.lang.String name, java.lang.String param) Get the value for the given namespace parameter in the specific profile.
java.lang.String	getPrimaryKeyName() Get the name of the surrogate primary key column used by the current project.
private SchemaConfig.Profile	getProfile(java.lang.String profile, boolean read) Obtain a profile based on its name.
java.io.File	getSchemaFile(java.lang.String nsName, java.lang.String type) Returns a file object representing the XML document associated with the specified database schema name of the default profile.
java.io.File	getSchemaFile(java.lang.String profile, java.lang.String nsName, java.lang.String type) Returns a file object representing the XML document associated with the specified database schema name of the specific profile.
java.lang.String	getSchemaFileName(java.lang.String nsName, java.lang.String type) Returns path to the resource representing the XML document associated with the specified database schema name in the default profile.
java.lang.String	getSchemaFileName(java.lang.String profile, java.lang.String nsName, java.lang.String type) Returns path to the resource representing the XML document associated with the specified database schema name in the requested profile.
java.lang.String	getSchemaResource(java.lang.String nsName, java.lang.String type) Returns path to the resource representing the XML document associated with the specified database schema name in the default profile.
java.lang.String	getSchemaResource(java.lang.String profile, java.lang.String nsName, java.lang.String type) Returns path to the resource representing the XML document associated with the specified database schema name in the requested profile.
java.util.List<java.lang.String>	getSchemas(boolean omitMeta) Get a list of schema names of the default profile, optionally omitting the name of the metadata schema.
java.util.List<java.lang.String>	getSchemas(java.lang.String profile, boolean omitMeta) Get a list of schema names, optionally omitting the name of the metadata schema.
int	getSqlConversion(java.lang.String nsName) Get the SQL name conversion override constant defined for a given schema namespace, if any.
boolean	isMetadataActive() Determine whether metadata is active for the current application.
boolean	isMutable(java.lang.String nsName) Returns the value of the mutable flag associated with the specified database schema name in a specific profile.
boolean	isPreferred(java.lang.String nsName) Reports whether the database should be preferred in cases where its entities are involved in ambiguous name conflicts.
boolean	isPreferred(java.lang.String profile, java.lang.String nsName) Reports whether the database should be preferred in cases where its entities are involved in ambiguous name conflicts.
java.util.Set<java.lang.String>	setActive(java.lang.String profile) Mark the specified profile as active and return all its configured namespaces.
void	setDefaultProfile(java.lang.String profileName) Sets the default configuration profile to be used during this process.
void	setMetadata(SchemaConfig.Metadata metadata) Name of metadata definition applied to every loaded schema.
void	setPrimaryKeyName(java.lang.String primaryKeyName) Set the name of the surrogate primary key name, overriding the default name of recid.
java.lang.String	toString() Returns a string representation of this SchemaConfig's object graph.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final ConversionStatus LOG

Logger for objects of this type.

developerModeWarned

private static boolean developerModeWarned

Flag used for simplify the log by avoiding multiple messages for trying developing mode search.

metadata

private SchemaConfig.Metadata metadata

Name of metadata definition applied to every loaded schema

profiles

private final java.util.Map<java.lang.String,SchemaConfig.Profile> profiles

Map of database names to namespace configuration data. The key in this map are case-insensitive.

unnamedProfile

private final SchemaConfig.Profile unnamedProfile

This is the unnamed profile. It contains all namespaces located directly in the schema node. This is the best configuration in a single profile configuration. Also, if there are some namespaces defined here and no other profiles was marked as default otherwise, this will become the default profile.

defaultProfile

private SchemaConfig.Profile defaultProfile

This is the default profile when the configuration is queried.

primaryKeyName

private java.lang.String primaryKeyName

Primary key name, hardcoded the same as Session.DEFAULT_PK

Constructor Detail

SchemaConfig

public SchemaConfig()

Default constructor.

Method Detail

isMetadataActive

public boolean isMetadataActive()

Determine whether metadata is active for the current application. Metadata is considered active if at least one metadata table is configured.

Returns:

true if the application uses metadata, else false.

getMetadata

public SchemaConfig.Metadata getMetadata()

Get the metadata identifier name associated with all schemas.

Returns:

Common schema metadata identifier.

setMetadata

public void setMetadata(SchemaConfig.Metadata metadata)

Name of metadata definition applied to every loaded schema.

Parameters:

metadata - Metadata definition name.

getPrimaryKeyName

public java.lang.String getPrimaryKeyName()

Get the name of the surrogate primary key column used by the current project.

Returns:

Surrogate primary key name.

setPrimaryKeyName

public void setPrimaryKeyName(java.lang.String primaryKeyName)

Set the name of the surrogate primary key name, overriding the default name of recid.

Parameters:

primaryKeyName - New surrogate primary key name.

getSchemas

public java.util.List<java.lang.String> getSchemas(boolean omitMeta)

Get a list of schema names of the default profile, optionally omitting the name of the metadata schema.

Parameters:

omitMeta - true to omit the metadata schema, false to include it.

getSchemas

public java.util.List<java.lang.String> getSchemas(java.lang.String profile,
                                                   boolean omitMeta)

Get a list of schema names, optionally omitting the name of the metadata schema.

Parameters:

profile - The profile to be processed.

omitMeta - true to omit the metadata schema, false to include it.

databases

public java.util.Iterator<java.lang.String> databases()

Get an iterator for the configured database names of default profile.

Returns:

Object which iterates over configured database names.

databases

public java.util.Iterator<java.lang.String> databases(boolean active)

Get an iterator for the configured database names of all activated profiles.

Returns:

Object which iterates over configured database names.

databases

public java.util.Iterator<java.lang.String> databases(java.lang.String profile)

Get an iterator for the configured database names of the requested profile.

Parameters:

profile - The profile to be processed. If null the default profile will be used.

Returns:

Object which iterates over configured database names.

defaultDatabases

public java.util.Iterator<java.lang.String> defaultDatabases()

Get an iterator of names of those databases which have been configured as default schemas for namespace lookup purposes. These are databases which are loaded automatically by a SchemaDictionary object at construction.

Returns:

Object which iterates over the names of default databases.

defaultDatabases

public java.util.Iterator<java.lang.String> defaultDatabases(java.lang.String profile)

Get an iterator of names of those databases which have been configured as default schemas for namespace lookup purposes. These are databases which are loaded automatically by a SchemaDictionary object at construction.

Parameters:

profile - The profile to be processed. If null the default profile will be used.

Returns:

Object which iterates over the names of default databases.

setDefaultProfile

public void setDefaultProfile(java.lang.String profileName)

Sets the default configuration profile to be used during this process. This profile is used when the methods of SchemaConfig which do not have the profile as parameter as the default referrer.

It is illegal to call this method twice during a process runtime. It is illegal to call this method after the object has already accessed with default getters. If this method was not called, when a default getter is invoked, a defaultProfile is selected automatically using the algorithm described in getDefaultProfile().

Parameters:

profileName - The name of the profile to be set as default.

addProfile

public void addProfile(ProfileConfig config)

Add a profile object to this configuration. Called by the configuration processor when reading the XML schema configuration.

Parameters:

config - The profile configuration.

setActive

public java.util.Set<java.lang.String> setActive(java.lang.String profile)

Mark the specified profile as active and return all its configured namespaces.

Parameters:

profile - The profile name.

Returns:

The set of namespaces.

deactiveDefaults

public void deactiveDefaults()

Deactivate all default profiles, as we are running in multi-profile mode. In this mode, each profile can be set as default, when a resource belonging to it gets processed (like a schema or a file).

addNamespace

public void addNamespace(SchemaConfig.NsConfig cfg)

Add a namespace configuration object to the default profile configuration. Called by the configuration processor when reading the XML schema configuration.

Parameters:

cfg - Namespace configuration object.

getImportFile

public java.io.File getImportFile(java.lang.String nsName)
                           throws ConfigurationException

Returns a file object representing the import (DF) file associated with the specified database schema name of the default profile. The file's path is fully qualified.

Parameters:

nsName - Name of desired namespace configuration

Returns:

Import file.

Throws:

ConfigurationException - if environment has not been configured correctly.

getImportFile

public java.io.File getImportFile(java.lang.String profile,
                                  java.lang.String nsName)
                           throws ConfigurationException

Returns a file object representing the import (DF) file associated with the specified database schema name in a specific profile. The file's path is fully qualified.

Parameters:

profile - The profile to be processed. If null the default profile will be used.

nsName - Name of desired namespace configuration

Returns:

Import file.

Throws:

ConfigurationException - if environment has not been configured correctly.

isMutable

public boolean isMutable(java.lang.String nsName)
                  throws ConfigurationException

Returns the value of the mutable flag associated with the specified database schema name in a specific profile.

Parameters:

nsName - Name of desired namespace configuration.

Returns:

true if the schema for the specified namespace configuration is mutable; false if it is not mutable, or if the specified namespace does not exist.

Throws:

ConfigurationException - if environment has not been configured correctly.

getSqlConversion

public int getSqlConversion(java.lang.String nsName)

Get the SQL name conversion override constant defined for a given schema namespace, if any.

Parameters:

nsName - Namespace name.

Returns:

SQL name conversion override mode.

See Also:

MatchPhraseConstants

getSchemaFile

public java.io.File getSchemaFile(java.lang.String nsName,
                                  java.lang.String type)
                           throws ConfigurationException

Returns a file object representing the XML document associated with the specified database schema name of the default profile. The file's path is fully qualified.

Parameters:

nsName - Name of desired namespace configuration

type - the type of resource (the file extension, including the dot).

Returns:

File containing namespace schema XML document.

Throws:

ConfigurationException - if environment has not been configured correctly.

getSchemaFile

public java.io.File getSchemaFile(java.lang.String profile,
                                  java.lang.String nsName,
                                  java.lang.String type)
                           throws ConfigurationException

Returns a file object representing the XML document associated with the specified database schema name of the specific profile. The file's path is fully qualified.

Parameters:

profile - The profile to be processed. If null the default profile will be used.

nsName - Name of desired namespace configuration

type - the type of resource (the file extension, including the dot).

Returns:

File containing namespace schema XML document.

Throws:

ConfigurationException - if environment has not been configured correctly.

getSchemaFileName

public java.lang.String getSchemaFileName(java.lang.String nsName,
                                          java.lang.String type)

Returns path to the resource representing the XML document associated with the specified database schema name in the default profile.

Parameters:

nsName - Name of desired namespace configuration

type - the type of resource (the file extension, including the dot).

Returns:

path to the resource containing namespace schema XML document or null if the resource doesn't exist.

getSchemaFileName

public java.lang.String getSchemaFileName(java.lang.String profile,
                                          java.lang.String nsName,
                                          java.lang.String type)

Returns path to the resource representing the XML document associated with the specified database schema name in the requested profile.

Parameters:

profile - The profile to be processed. If null the default profile will be used.

nsName - Name of desired namespace configuration

type - the type of resource (the file extension, including the dot).

Returns:

path to the resource containing namespace schema XML document or null if the resource doesn't exist.

getSchemaResource

public java.lang.String getSchemaResource(java.lang.String nsName,
                                          java.lang.String type)

Returns path to the resource representing the XML document associated with the specified database schema name in the default profile.

Parameters:

nsName - Name of desired namespace configuration

type - the type of resource (the file extension, including the dot).

Returns:

path to the resource containing namespace schema XML document or null if the resource doesn't exist.

getSchemaResource

public java.lang.String getSchemaResource(java.lang.String profile,
                                          java.lang.String nsName,
                                          java.lang.String type)

Returns path to the resource representing the XML document associated with the specified database schema name in the requested profile.

Parameters:

profile - The profile to be processed. If null the default profile will be used.

nsName - Name of desired namespace configuration

type - the type of resource (the file extension, including the dot).

Returns:

path to the resource containing namespace schema XML document or null if the resource doesn't exist.

isPreferred

public boolean isPreferred(java.lang.String nsName)

Reports whether the database should be preferred in cases where its entities are involved in ambiguous name conflicts.

Parameters:

nsName - Name of desired namespace configuration

Returns:

true if the database is preferred.

isPreferred

public boolean isPreferred(java.lang.String profile,
                           java.lang.String nsName)

Reports whether the database should be preferred in cases where its entities are involved in ambiguous name conflicts.

Parameters:

profile - The profile to be processed. If null the default profile will be used.

nsName - Name of desired namespace configuration

Returns:

true if the database is preferred.

getNamespaceParameter

public java.lang.String getNamespaceParameter(java.lang.String name,
                                              java.lang.String param)

Get the value for the given namespace parameter in the default profile.

Parameters:

name - The namespace name.

param - The parameter name or path.

Returns:

The parameter's value or null if name or param are invalid.

getNamespaceParameter

public java.lang.String getNamespaceParameter(java.lang.String profile,
                                              java.lang.String name,
                                              java.lang.String param)

Get the value for the given namespace parameter in the specific profile.

Parameters:

profile - The profile to be processed. If null the default profile will be used.

name - The namespace name.

param - The parameter name or path.

Returns:

The parameter's value or null if name or param are invalid.

toString

public java.lang.String toString()

Returns a string representation of this SchemaConfig's object graph.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

getDefaultProfile

private SchemaConfig.Profile getDefaultProfile()

Returns the default profile. If no profile was programmatically configured as default, the following algorithm will be used to select one:

1. scan for first profile having the default attribute set;
2. use the unnamed profile if not empty. The unnamed profile is the profile composed from the namespaces located directly in schema tag, at the same level with the other named profile-s. In case there are no named profiles, this cause the unnamed profile to be the default, naturally matching the old configuration files where profiles were not supported (backward compatibility);
3. scan for first available profile if any named profile is defined;
4. otherwise, use the unnamed profile

Returns:

the default profile. Never null.

getProfile

private SchemaConfig.Profile getProfile(java.lang.String profile,
                                        boolean read)

Obtain a profile based on its name.

Parameters:

profile - The name of the profile to be returned. If null, the unnamed profile is returned.

read - Use true is the configuration is read from file, during the SchemaConfig construction. Use false when accessing from a getter.

Returns:

The requested profile, as described above.