com.goldencode.p2j.schema

Class SchemaConfig.NsConfig

java.lang.Object

com.goldencode.p2j.schema.SchemaConfig.NsConfig

Enclosing class:

SchemaConfig

public static class SchemaConfig.NsConfig
extends java.lang.Object

Encapsulates information about a namespace configuration, including name, XML file, and whether namespace should be loaded into the schema dictionary by default.

This class is public since it must be accessed as part of the public API for the containing class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaConfig.NsConfig.DialectParam Helper class to read and set the dialect parameter.

Field Summary

Fields

Modifier and Type	Field and Description
private int	conversion SQL name conversion override for SQL table and column names.
private boolean	defDb Flag indicating if namespace is loaded by default.
private java.lang.String	importFile Name of .df import file.
private boolean	mutable Whether the schema is mutable (it can be modified externally and is scanned at runtime)
private java.lang.String	name Identifying name for namespace.
private java.util.Map<java.lang.String,java.lang.String>	parameters Namespace parameters.
private boolean	prefer Namespace is preferred in ambiguous name conflicts.

Constructor Summary

Constructors

Constructor and Description
NsConfig() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addDialectParameter(SchemaConfig.NsConfig.DialectParam dialectParam) Add the specified dialect parameters to the namespace.
void	addParameter(Parameter param) Add the specified parameter to the namespace.
java.lang.String	getConversion() Get the type of conversion performed on SQL names.
java.lang.String	getDataArtifactsLocation() Get the location for .dict, .schema, and .p2o files of this namespace.
java.lang.String	getImportFile() Get DF import filename, defaulting to standard location for .df files if not explicitly configured in p2j.cfg.xml.
java.lang.String	getName() Get identifying namespace name.
java.lang.String	getParameter(java.lang.String param) Get the value for the specified namespace parameter.
boolean	isDefault() Is this namespace loaded in the schema dictionary by default?
boolean	isMutable() Get the mutable flag.
boolean	isPreferred() Is this namespace preferred when its components are involved in ambiguous name conflicts?
void	setConversion(java.lang.String conversion) Set the type of conversion performed on SQL names.
void	setDefault(boolean defDb) Set default flag for this namespace configuration.
void	setImportFile(java.lang.String importFile) Set DF import filename.
void	setMutable(boolean mutable) Set the mutable flag.
void	setName(java.lang.String name) Set name.
void	setPreferred(boolean prefer) Set preferred flag for this namespace configuration.
void	setXmlFile(java.lang.String xmlFile) Notify of the extra namespace parameter instead of abending the application.

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

Identifying name for namespace.

mutable

private boolean mutable

Whether the schema is mutable (it can be modified externally and is scanned at runtime)

importFile

private java.lang.String importFile

Name of .df import file.

conversion

private int conversion

SQL name conversion override for SQL table and column names.

defDb

private boolean defDb

Flag indicating if namespace is loaded by default.

prefer

private boolean prefer

Namespace is preferred in ambiguous name conflicts.

parameters

private final java.util.Map<java.lang.String,java.lang.String> parameters

Namespace parameters.

Constructor Detail

NsConfig

public NsConfig()

Default constructor.

Method Detail

getName

public java.lang.String getName()

Get identifying namespace name.

Returns:

Namespace name.

setName

public void setName(java.lang.String name)

Set name.

Parameters:

name - Namespace name.

isMutable

public boolean isMutable()

Get the mutable flag.

Returns:

true if the database schema is mutable, else false.

setMutable

public void setMutable(boolean mutable)

Set the mutable flag.

Parameters:

mutable - true if the database schema is mutable, else false.

getImportFile

public java.lang.String getImportFile()

Get DF import filename, defaulting to standard location for .df files if not explicitly configured in p2j.cfg.xml.

Returns:

Import filename.

setImportFile

public void setImportFile(java.lang.String importFile)

Set DF import filename.

Parameters:

importFile - Import filename.

getConversion

public java.lang.String getConversion()

Get the type of conversion performed on SQL names.

Returns:

Type of conversion performed on SQL names.

setConversion

public void setConversion(java.lang.String conversion)

Set the type of conversion performed on SQL names.

Parameters:

conversion - Type of conversion performed on SQL names.

getDataArtifactsLocation

public java.lang.String getDataArtifactsLocation()

Get the location for .dict, .schema, and .p2o files of this namespace. This is the same as the directory of the import file, relative to application's jar root at runtime and relative to $cvtpath at conversion time.

Returns:

as described above.

isDefault

public boolean isDefault()

Is this namespace loaded in the schema dictionary by default?

Returns:

true if namespace is loaded by default, else false.

setDefault

public void setDefault(boolean defDb)

Set default flag for this namespace configuration.

Parameters:

defDb - true if namespace is loaded by default, else false.

isPreferred

public boolean isPreferred()

Is this namespace preferred when its components are involved in ambiguous name conflicts?

Returns:

true if namespace is preferred, else false.

setPreferred

public void setPreferred(boolean prefer)

Set preferred flag for this namespace configuration. This can resolve ambiguous name conflicts if this namespace is the only one that is preferred out of all the conflicting names.

Parameters:

prefer - true if namespace is preferred, else false.

setXmlFile

public void setXmlFile(java.lang.String xmlFile)

Notify of the extra namespace parameter instead of abending the application. This method (and the "xmlFile" from the namespace options list (see its XML setup in Configuration.setupHandler) will be removed in a future revision.

Parameters:

xmlFile - ignored

addParameter

public void addParameter(Parameter param)

Add the specified parameter to the namespace.

Parameters:

param - The parameter.

addDialectParameter

public void addDialectParameter(SchemaConfig.NsConfig.DialectParam dialectParam)

Add the specified dialect parameters to the namespace.

All the parameter's names will follow the [dialect]/[parameter] syntax.

Parameters:

dialectParam - The dialect parameter.

getParameter

public java.lang.String getParameter(java.lang.String param)

Get the value for the specified namespace parameter.

Parameters:

param - The parameter name.

Returns:

The parameter's value.