psdi.mbo

Class MaximoDD

java.lang.Object

psdi.mbo.MaximoDD

All Implemented Interfaces:

MaximoCache, FixedLoggerNames, FixedLoggers

public class MaximoDD
extends java.lang.Object
implements MaximoCache, FixedLoggers

Main class for the MAXIMO Data dictionary. This class loads all the MAXIMO data dictionary information from the database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaximoDD.PropertyListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	fetchResultStopLimit
static java.lang.String	fetchStopExclusion
static java.lang.String	fetchStopLimitEnabled
static long	ID_SEED
static java.lang.String	lookupMaxRowProperty

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
MaximoDD() Basic construtor (does nothing really)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAltIxName(java.lang.String table) Get the alternate index name of this table.
java.util.HashMap<java.lang.String,java.lang.String>	getAppFieldDefaults(java.lang.String appName, java.lang.String objectName, java.lang.String siteid, java.lang.String userName, java.util.HashSet groupNames) For a given appname,objectName,siteid,user and group returns appfielddefaults records
java.lang.String	getBaseCurrency(java.lang.String orgId) Returns the base currency for a given orgid.
java.lang.String	getBaseObjectName(java.lang.String tableName) Returns name of the base table for an extension table.
java.lang.String	getContentAttrName(java.lang.String table) Returns the content attribute name of the given table.
double	getDB2Version() Get the DB2 version (e.g.
int	getDBPlatform() Return the DB platform.
java.lang.String	getDomainFactoryName(java.lang.String domainType) The method to get domain factory class name.
DomainInfo	getDomainInfo(java.lang.String name) Return information about a specific domain
java.util.Iterator	getDomainsInfo() Return information about all domains
java.lang.String	getExtTableName(java.lang.String table) Returns the extended table name for a table
java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Object>>	getGLConfigure() Return template glConfigure TreeMap of information from GLConfigure table for null orgid.
java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Object>>	getGLConfigure(java.lang.String orgid) Return glConfigure TreeMap of information from GLConfigure table for the specified orgid.
java.lang.String[]	getIndexInfo(java.lang.String ixname) If the specified index names is defined in our metadata as an index, then return the names of the columns that participate in the index.
java.lang.String	getLangCodeColumn(java.lang.String table) Returns the column name for the language code column of the table.
java.lang.String	getLangTableName(java.lang.String table) Returns the language table of the given table.
MboSetInfo	getMboSetInfo(java.lang.String ms) Return Information about a specified MboSet
java.util.Iterator	getMboSetsInfo() Return Information about all MboSets in the dictionary
java.lang.String	getName() Returns the name of this cache object
double	getOraVersion() Get the Oracle version (e.g.
java.lang.String	getOrgId(java.lang.String siteId) Returns the orgid for a given siteid.
RelationInfo	getRelationInfo(java.lang.String n) Deprecated. This method is nolonger supported. Returns null.
java.util.HashMap<java.lang.String,RelationInfo>	getRelationships(java.lang.String objectName) Looks up for the passed in object name in the cache and returns a HashMap object that contains all the relationships defined for the business object, if found, otherwise returns null.
java.util.Iterator	getRelationsInfo() Return Information about all MboSet relationships
java.lang.String	getSequenceName(java.lang.String tbName, java.lang.String colName) Gets the sequence name for the table name and column name
ServiceInfo	getServiceInfo(java.lang.String service) Return information about the specified service
java.util.Iterator	getServicesInfo() Return info about all services
int	getStorageType(java.lang.String table) Return the storage type of the table.
Translate	getTranslator() Return the translator object.
java.lang.String	getUniqueIdColumn(java.lang.String table) Returns the unique id column of the given table.
void	init() Build the data dictionary.
boolean	isDeltaStorageObject(java.lang.String objectName)
boolean	isESigEnabled(java.lang.String applicationName, java.lang.String optionName) Checks to see if a particular option is esig enabled for the given application.
boolean	isExtTable(java.lang.String tableName) Returns true if tableName is a name to an extension table.
boolean	isLongDescriptionSearchable() Returns true to indicate that the longdescription is searchable through QBE.
boolean	isMLInUse(java.lang.String table) Returns wether the given table is ml in use.
boolean	isSiteInOrganization(java.lang.String siteId, java.lang.String orgId) Returns whether the siteId belongs to the orgId or not.
boolean	isValidOrganization(java.lang.String orgId) Returns whether the organization is valid or not.
boolean	isValidSite(java.lang.String siteId) Returns whether the site is valid or not.
void	reload() Reload all of MaximoDD.
void	reload(java.lang.String key) Initialize a specific component of the cache identified by the key.
boolean	storeBlobAsBlob() Identifies whether the maxtype BLOB is stored as a native Blob datatype.
boolean	storeClobAsClob() Identifies whether the maxtype CLOB is stored as a native Clob datatype.
boolean	storeLongalnAsClob() Identifies whether the maxtype LONGALN is stored as a native Clob datatype.
java.lang.String	toString() Dumps the entire dictionary as a string - use for debugging only
void	updateMboValueInfoWithDomainInfo() Loop though the existing mbovalueinfo which has a domain info associated with it and update the reference using the new DomainInfo object in the domain info cache.
void	updateMboValueInfoWithDomainInfo(java.lang.String domainId) Loop though the existing mbovalueinfo which has the specified domain associated with it and update the reference using the new DomainInfo object in the domain info cache.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID_SEED

public static final long ID_SEED

See Also:

Constant Field Values

fetchResultStopLimit

public static final java.lang.String fetchResultStopLimit

See Also:

Constant Field Values

fetchStopLimitEnabled

public static final java.lang.String fetchStopLimitEnabled

See Also:

Constant Field Values

fetchStopExclusion

public static final java.lang.String fetchStopExclusion

See Also:

Constant Field Values

lookupMaxRowProperty

public static final java.lang.String lookupMaxRowProperty

See Also:

Constant Field Values

Constructor Detail

MaximoDD

public MaximoDD()

Basic construtor (does nothing really)

Method Detail

getName

public java.lang.String getName()

Returns the name of this cache object

Specified by:

getName in interface MaximoCache

Returns:

init

public void init()
          throws MXException

Build the data dictionary. This will load the entire data dictionary.

Specified by:

init in interface MaximoCache

Throws:

MXException

reload

public void reload()
            throws MXException

Reload all of MaximoDD. Subsets of MaximoDD can be reloaded via reload with the key parameter.

Specified by:

reload in interface MaximoCache

Throws:

MXException

reload

public void reload(java.lang.String key)
            throws MXException

Initialize a specific component of the cache identified by the key.

Specified by:

reload in interface MaximoCache

Parameters:

key - Currently supported keys are as follows.

1. OBJECT:objectname -- See reloadObject. Multiple object names can be delimited by "|". One or more object names must be specified.
2. DOMAININFO:domainname -- See reloadDomain.
3. ESIGOPTIONS -- Updates the names of all eSig-enabled options, reading from SigOption table. This updates the eSigOptions HashMap. See loadESigOptions.
4. GLCONFIGURE -- Updates the information from GLConfigure table.
5. RELATIONS -- Updates all relationships, reading from MaxRelationship table. This updates the relations HashMap. See loadRelationsInfo and loadRelationsInfoToLangTables. Reload is invoked when MaxRelationshipSet is saved.
6. METASEQUENCE -- Updates the sequences for the metadata tables. See loadSequenceInfo. For SqlServer, also see MaxSequenceProvider. Reload is invoked when configuration changes are backed out and the metadata sequences are rebuilt (see ConfigureService).
7. INDEXES -- Clears the lazy-load cache of indexes.*

Throws:

MXException

getDBPlatform

public int getDBPlatform()

Return the DB platform.

Returns:

One of the constants from UpgConstants -- ORACLE, SQLSERVER, DB2.

See Also:

UpgConstants

getOraVersion

public double getOraVersion()

Get the Oracle version (e.g. 10.2). If not Oracle, this will return 0.

Returns:

See Also:

Util.getOracleVersion(boolean)

getDB2Version

public double getDB2Version()

Get the DB2 version (e.g. 8.2). If not DB2, this will return 0.

Returns:

See Also:

Util.getDB2Version(boolean)

getAppFieldDefaults

public java.util.HashMap<java.lang.String,java.lang.String> getAppFieldDefaults(java.lang.String appName,
                                                                       java.lang.String objectName,
                                                                       java.lang.String siteid,
                                                                       java.lang.String userName,
                                                                       java.util.HashSet groupNames)

For a given appname,objectName,siteid,user and group returns appfielddefaults records

Parameters:

appName -

objectName -

siteid -

userName -

groupName -

Returns:

haspmap for columnname and defaultvalue

Throws:

MXException

getSequenceName

public java.lang.String getSequenceName(java.lang.String tbName,
                               java.lang.String colName)

Gets the sequence name for the table name and column name

Parameters:

tbName -

colName -

Returns:

sequence name

getRelationships

public java.util.HashMap<java.lang.String,RelationInfo> getRelationships(java.lang.String objectName)

Looks up for the passed in object name in the cache and returns a HashMap object that contains all the relationships defined for the business object, if found, otherwise returns null.

Parameters:

objectName - name of a business object

Returns:

a HashMap object that contains all the relationships defined for the business object, if found, otherwise returns null.

updateMboValueInfoWithDomainInfo

public void updateMboValueInfoWithDomainInfo()

Loop though the existing mbovalueinfo which has a domain info associated with it and update the reference using the new DomainInfo object in the domain info cache. This method is called when the domain info is realoaded.

updateMboValueInfoWithDomainInfo

public void updateMboValueInfoWithDomainInfo(java.lang.String domainId)

Loop though the existing mbovalueinfo which has the specified domain associated with it and update the reference using the new DomainInfo object in the domain info cache. This method is called when the domain info is realoaded.

isLongDescriptionSearchable

public boolean isLongDescriptionSearchable()

Returns true to indicate that the longdescription is searchable through QBE.

getDomainFactoryName

public java.lang.String getDomainFactoryName(java.lang.String domainType)
                                      throws MXException

The method to get domain factory class name.

Parameters:

domainType -

Returns:

Throws:

MXException

getOrgId

public java.lang.String getOrgId(java.lang.String siteId)

Returns the orgid for a given siteid.

Parameters:

siteId -

Returns:

orgId

isValidSite

public boolean isValidSite(java.lang.String siteId)

Returns whether the site is valid or not.

Parameters:

siteId -

Returns:

True if valid site else false

isValidOrganization

public boolean isValidOrganization(java.lang.String orgId)

Returns whether the organization is valid or not.

Parameters:

orgId -

Returns:

True if valid organization else false

isSiteInOrganization

public boolean isSiteInOrganization(java.lang.String siteId,
                           java.lang.String orgId)

Returns whether the siteId belongs to the orgId or not.

Parameters:

siteId -

orgId -

Returns:

true if site is in org else false

getGLConfigure

public java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Object>> getGLConfigure()

Return template glConfigure TreeMap of information from GLConfigure table for null orgid. This is used only in special situations. Normally you should call getGLConfigure.

See Also:

glConfigure, getGLConfigure(String)

getGLConfigure

public java.util.TreeMap<java.lang.Integer,java.util.HashMap<java.lang.String,java.lang.Object>> getGLConfigure(java.lang.String orgid)

Return glConfigure TreeMap of information from GLConfigure table for the specified orgid.

Parameters:

orgid -

See Also:

glConfigure

isESigEnabled

public boolean isESigEnabled(java.lang.String applicationName,
                    java.lang.String optionName)

Checks to see if a particular option is esig enabled for the given application. If LoginTracking is turned off, this method will return False.

Parameters:

applicationName -

optionName -

Returns:

true if app is esig enabled for the option else false

getBaseCurrency

public java.lang.String getBaseCurrency(java.lang.String orgId)

Returns the base currency for a given orgid.

Parameters:

orgId -

Returns:

base currency

getTranslator

public Translate getTranslator()

Return the translator object. Used for value list conversion and other localization functions.

Returns:

Translate object

toString

public java.lang.String toString()

Dumps the entire dictionary as a string - use for debugging only

Overrides:

toString in class java.lang.Object

getServiceInfo

public ServiceInfo getServiceInfo(java.lang.String service)

Return information about the specified service

Parameters:

service -

Returns:

ServiceInfo object

getServicesInfo

public java.util.Iterator getServicesInfo()

Return info about all services

Returns:

service Iterator

getIndexInfo

public java.lang.String[] getIndexInfo(java.lang.String ixname)
                                throws MXException,
                                       java.rmi.RemoteException

If the specified index names is defined in our metadata as an index, then return the names of the columns that participate in the index.

Parameters:

ixname - Index name

Returns:

HashSet of column names in the index

Throws:

MXException

java.rmi.RemoteException

getMboSetInfo

public MboSetInfo getMboSetInfo(java.lang.String ms)

Return Information about a specified MboSet

Parameters:

ms -

Returns:

MboSetInfo object for the name

getMboSetsInfo

public java.util.Iterator getMboSetsInfo()

Return Information about all MboSets in the dictionary

Returns:

MboSetsInfo Iterator

getRelationInfo

public RelationInfo getRelationInfo(java.lang.String n)

Deprecated. This method is nolonger supported. Returns null.

Return Information about a named relationship

getRelationsInfo

public java.util.Iterator getRelationsInfo()

Return Information about all MboSet relationships

Returns:

relationInfo iterator

getDomainsInfo

public java.util.Iterator getDomainsInfo()

Return information about all domains

Returns:

domain information iterator

getDomainInfo

public DomainInfo getDomainInfo(java.lang.String name)

Return information about a specific domain

Parameters:

name -

Returns:

DomainInfo object for the name

storeClobAsClob

public boolean storeClobAsClob()

Identifies whether the maxtype CLOB is stored as a native Clob datatype.

Returns:

True if maxtype CLOB is stored as native Clob

storeLongalnAsClob

public boolean storeLongalnAsClob()

Identifies whether the maxtype LONGALN is stored as a native Clob datatype.

Returns:

True if maxtype LONGALN is stored as native Clob

storeBlobAsBlob

public boolean storeBlobAsBlob()

Identifies whether the maxtype BLOB is stored as a native Blob datatype.

Returns:

True if maxtype BLOB is stored as native Blob

getLangTableName

public java.lang.String getLangTableName(java.lang.String table)

Returns the language table of the given table.

Parameters:

table -

Returns:

getUniqueIdColumn

public java.lang.String getUniqueIdColumn(java.lang.String table)

Returns the unique id column of the given table.

Parameters:

table -

Returns:

getContentAttrName

public java.lang.String getContentAttrName(java.lang.String table)

Returns the content attribute name of the given table.

Parameters:

table -

Returns:

content attribute name

getLangCodeColumn

public java.lang.String getLangCodeColumn(java.lang.String table)

Returns the column name for the language code column of the table.

Parameters:

table -

Returns:

isMLInUse

public boolean isMLInUse(java.lang.String table)

Returns wether the given table is ml in use.

Parameters:

table -

Returns:

getAltIxName

public java.lang.String getAltIxName(java.lang.String table)

Get the alternate index name of this table.

Parameters:

table -

Returns:

The alternate index name.

getStorageType

public int getStorageType(java.lang.String table)

Return the storage type of the table.

Parameters:

table -

Returns:

isDeltaStorageObject

public boolean isDeltaStorageObject(java.lang.String objectName)

getExtTableName

public java.lang.String getExtTableName(java.lang.String table)

Returns the extended table name for a table

Parameters:

table -

Returns:

isExtTable

public boolean isExtTable(java.lang.String tableName)

Returns true if tableName is a name to an extension table.

Parameters:

tableName -

Returns:

getBaseObjectName

public java.lang.String getBaseObjectName(java.lang.String tableName)

Returns name of the base table for an extension table.

Parameters:

tableName -

Returns: