psdi.configure

Class TableElement

java.lang.Object

org.jdom2.Content

org.jdom2.Element

psdi.configure.TableElement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.jdom2.NamespaceAware, org.jdom2.Parent, UpgConstants

public class TableElement
extends org.jdom2.Element
implements UpgConstants

Element to represent a table (maxobject or maxobjectcfg) in the XML file that is output by BuildUpgMetadata and input to Upgrade. This is an extension of org.jdom.Element.

TableElement is instanciated by the following:

• When writing XML (BuildUpgMetadata), instanciated from compareTableMeta. The constructor will populate the TableElement object appropriately, and populate with children for ColumnElement.
• When reading XML (Upgrade), instanciated from ConfigXMLFactory}, via Upgrade. The TableElement methods TableElement.getAddSql(String, Connection, Util, HashMap) and TableElement.getUpdateSql(String, Connection, Util, HashMap) return sql statements for modifying the table metadata prior to running ConfigDB.

This class supports the following special codes during the Upgrade. If any additional codes are supported in the future, they should be documented here and in the UpgCodes file in PVCS. Also see comments in BuildUpgMetadata.

Attribute Name	Description
forcedrop	When performing the Upgrade, if table is being dropped, and it contains data, this class will mark it as user-defined rather than actually dropping it. However, if the UpgCodes XML file that is input to BuildUpgMetadata provides a table attribute named "forcedrop" with any value other than N or NO, the table will be dropped regardless of whether it contains data. For example: <TABLE tbname="JOBOPERATION" forcedrop="Y"> </TABLE>
forcerebuild	For the Upgrade, if the table is being changed, and you anticipate that the Utility class may determine that the table needs to simply be altered (rather than rebuilt), and you want to force a rebuild because you need some complex logic for reloading the data, then UpgCodes XML file that is input to BuildUpgMetadata should provide a table attribute named "forcerebuild" with any value other than N or NO. This would be done only in unusual circumstances. For example: <TABLE tbname="ITEM" forcerebuild="Y"> </TABLE>

See Also:

psdi.upgrade.BuildUpgMetadata, psdi.upgrade.Upgrade, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jdom2.Content

org.jdom2.Content.CType

Field Summary

Fields inherited from class org.jdom2.Element

name, namespace

Fields inherited from class org.jdom2.Content

ctype, parent

Fields inherited from interface psdi.configure.UpgConstants

DB2, doNotUpdateACTION, doNotUpdateALNDOMAIN, doNotUpdateAPPLICATIONAUTH, doNotUpdateAUTOKEY, doNotUpdateCONDITION, doNotUpdateCONTRACTPROPERTY, doNotUpdateCONTRACTTYPE, doNotUpdateCROSSOVERDOMAIN, doNotUpdateDOCTYPES, doNotUpdateLANGUAGE, doNotUpdateMAXAPPS, doNotUpdateMAXCONDDETAIL, doNotUpdateMAXCONTROLVALUE, doNotUpdateMAXDOMAIN, doNotUpdateMAXLOGAPPENDER, doNotUpdateMAXLOGGER, doNotUpdateMAXMENU, doNotUpdateMAXMESSAGES, doNotUpdateMAXMODULES, doNotUpdateMAXPROP, doNotUpdateMAXPROPVALUE, doNotUpdateMAXROLE, doNotUpdateMAXSEQUENCE, doNotUpdateMAXSERSECURITY, doNotUpdateMAXSERVICE, doNotUpdateMAXTABLEDOMAIN, doNotUpdateMAXVARS, doNotUpdateMAXVARTYPE, doNotUpdateMXCOLLAB, doNotUpdateMXCOLLABREF, doNotUpdateNUMERICDOMAIN, doNotUpdateNUMRANGEDOMAIN, doNotUpdatePORTLET, doNotUpdatePRICALC, doNotUpdateSECURITYRESTRICT, doNotUpdateSIGOPTION, doNotUpdateSYNONYMDOMAIN, doNotUpdateTAXTYPE, doNotUpdateWORKPRIORITY, doNotUpdateWORKTYPE, doNotUpdateWPEDITSETTING, messageCache, NEWONLY, OLDANDNEW, OLDONLY, ORACLE, SQLINET, SQLMICROSOFT, SQLSERVER, SYSDATATABLES, SYSTEMTABLES, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
TableElement(java.lang.String tbname, java.util.HashMap newTable, java.util.HashMap oldTable) This constructor is used when creating a new TableElement for the purpose of writing out XML.
TableElement(java.lang.String name, org.jdom2.Namespace namespace, java.lang.String dir)
TableElement(java.lang.String name, java.lang.String dir)
TableElement(java.lang.String name, java.lang.String uri, java.lang.String dir)
TableElement(java.lang.String name, java.lang.String prefix, java.lang.String uri, java.lang.String dir)

Method Summary

Modifier and Type	Method and Description
boolean	addView() Determine if the object is to be added as a view.
java.util.ArrayList	adjustView(java.util.HashMap baseTable, Util util) Verify that all views are defined correctly, including: autoselect views must view all columns on the table if a column is required, view of column must be required
boolean	forceDrop() Determine whether the table must be dropped.
boolean	forceRebuild() Determine whether the table must be rebuilt.
java.util.ArrayList	getAddSql(java.lang.String tbname, java.sql.Connection con, Util util, java.util.HashMap oldTable) When reading XML, called from psdi.upgrade.Upgrade#Upgrade.
ColumnElement	getColumn(java.lang.String colName) Get a particular ColumnElement for this TableElement.
java.util.List	getColumns() Get the columns for this table.
java.util.TreeMap	getColumnsFromTable(java.util.HashMap table) Fetch the maximo column definitions as stored in a table HashMap.
java.lang.String	getDropIndexesSql(java.lang.String tableName) Generate SQL to drop indexes for a table.
java.lang.String	getNewChanged() Get the new value for maxobjectcfg.changed (newChanged).
java.util.HashMap	getNewHashmap(java.util.HashMap oldMap, boolean rebuild) This method can be used when reading XML to output a HashMap in the format of Util.getAttributeMeta(String, boolean, boolean, boolean, boolean, boolean, String).
protected int	getNextAttributeID() Used when adding new rows to maxattributecfg to get the next value for attributeno.
int	getNextVal(java.lang.String tableName, java.lang.String columnName) Get the next sequential value for a column.
protected int	getNextViewColumnID() Used when adding new rows to maxviewcolumncfg to get the next value for TableElement.viewcolumnno.
java.util.ArrayList	getPreDropSql() Prior to dropping a table, update its columns and attributes.
java.lang.String	getStatus() Get the value of the table's attribute value "status" (see status).
org.jdom2.Element	getTableAttribute(java.lang.String attrName) Get a particular attribute element for this TableElement.
java.util.List	getTableAttributes() Get the attributes for this TableElement.
java.lang.String	getTableName() Get the table name.
int	getUpdateCount() When validating the XML against the database, determine the number of attributes that are being updated for a table and its columns.
java.util.ArrayList	getUpdateSql(java.lang.String tbname, java.sql.Connection con, Util util, java.util.HashMap oldTable) When reading XML, called from Upgrade.
boolean	isView() Determine if the object is a view.
boolean	isView(java.util.HashMap objMap) Determine if the object is a view.
void	setNewChanged(java.lang.String value) Set the new value for maxobjectcfg.changed (newChanged).
void	setTableName(java.lang.String tableName) Set the table name.
java.util.HashMap	toHashmap(java.util.HashMap oldMap) This method can be used when reading XML to output a HashMap in the format of getObjectMeta.

Methods inherited from class org.jdom2.Element

addContent, addContent, addContent, addContent, addContent, addNamespaceDeclaration, canContainContent, clone, cloneContent, coalesceText, detach, getAdditionalNamespaces, getAttribute, getAttribute, getAttributes, getAttributesSize, getAttributeValue, getAttributeValue, getAttributeValue, getAttributeValue, getChild, getChild, getChildren, getChildren, getChildren, getChildText, getChildText, getChildTextNormalize, getChildTextNormalize, getChildTextTrim, getChildTextTrim, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getName, getNamespace, getNamespace, getNamespacePrefix, getNamespacesInherited, getNamespacesInScope, getNamespacesIntroduced, getNamespaceURI, getQualifiedName, getText, getTextNormalize, getTextTrim, getValue, getXMLBaseURI, hasAdditionalNamespaces, hasAttributes, indexOf, isAncestor, isRootElement, removeAttribute, removeAttribute, removeAttribute, removeChild, removeChild, removeChildren, removeChildren, removeContent, removeContent, removeContent, removeContent, removeNamespaceDeclaration, setAttribute, setAttribute, setAttribute, setAttributes, setContent, setContent, setContent, setContent, setName, setNamespace, setText, sortAttributes, sortChildren, sortContent, sortContent, toString

Methods inherited from class org.jdom2.Content

equals, getCType, getDocument, getParent, getParentElement, hashCode, setParent

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jdom2.Parent

getDocument, getParent

Constructor Detail

TableElement

public TableElement(java.lang.String name,
                    org.jdom2.Namespace namespace,
                    java.lang.String dir)

Parameters:

name - Name of the table.

namespace -

dir - Callout directory.

TableElement

public TableElement(java.lang.String name,
                    java.lang.String dir)

Parameters:

name - Name of the table.

dir - Callout directory.

TableElement

public TableElement(java.lang.String name,
                    java.lang.String uri,
                    java.lang.String dir)

Parameters:

name - Name of the table.

uri -

dir - Callout directory.

TableElement

public TableElement(java.lang.String name,
                    java.lang.String prefix,
                    java.lang.String uri,
                    java.lang.String dir)

Parameters:

name - Name of the table.

prefix -

uri -

dir - Callout directory.

TableElement

public TableElement(java.lang.String tbname,
                    java.util.HashMap newTable,
                    java.util.HashMap oldTable)
             throws java.lang.Exception

This constructor is used when creating a new TableElement for the purpose of writing out XML. It calls buildFromHashMaps.

Parameters:

tbname - Name of the table.

newTable - The table from the new database.

oldTable - The table from the old database.

Throws:

java.lang.Exception

See Also:

TableElement.buildFromHashMaps()

Method Detail

isView

public boolean isView(java.util.HashMap objMap)

Determine if the object is a view. See if the ISVIEW attribuite is set to true.

Parameters:

objMap - HashMap containing the object to test.

Returns:

true if the object is a view

isView

public boolean isView()
               throws java.lang.Exception

Determine if the object is a view.

Returns:

true if the object is a view

Throws:

java.lang.Exception

addView

public boolean addView()
                throws java.lang.Exception

Determine if the object is to be added as a view. See if the ISVIEW attribute is specified and set to true.

Returns:

true if the object is being added as a view

Throws:

java.lang.Exception

getTableName

public java.lang.String getTableName()

Get the table name.

Returns:

The table name.

setTableName

public void setTableName(java.lang.String tableName)

Set the table name.

Parameters:

tableName - The value to set as the table name.

getStatus

public java.lang.String getStatus()

Get the value of the table's attribute value "status" (see status). This will equal OLDONLY, NEWONLY, or OLDANDNEW to indicate whether the table exists in the old database, the new database, or both.

Returns:

The value of the "status" attribute.

getNewChanged

public java.lang.String getNewChanged()

Get the new value for maxobjectcfg.changed (newChanged).

Returns:

The new value for changed.

setNewChanged

public void setNewChanged(java.lang.String value)

Set the new value for maxobjectcfg.changed (newChanged).

forceDrop

public boolean forceDrop()

Determine whether the table must be dropped. If FORCEDROP is specified in UpgCodes.xml, then the table must be dropped.

Returns:

true is FORCEDROP was specified in UpgCodes.

forceRebuild

public boolean forceRebuild()

Determine whether the table must be rebuilt. If FORCEREBUILD is specified in UpgCodes.xml, then the table must be rebuilt.

Returns:

true is FORCEDROP was specified in UpgCodes.

getColumnsFromTable

public java.util.TreeMap getColumnsFromTable(java.util.HashMap table)
                                      throws java.lang.Exception

Fetch the maximo column definitions as stored in a table HashMap. This method combines column attributes, as defined by $MAXATTRIBUTES, and view column attributes, as defined by $MAXVIEWCOLUMNS.

Parameters:

table - HashMap containing a full maximo table definition.

Returns:

TreeMap containing all Maximo column definitions for this table

Throws:

java.lang.Exception

getTableAttributes

public java.util.List getTableAttributes()
                                  throws java.lang.Exception

Get the attributes for this TableElement. Each "attribute" represents a cell from maxobjectcfg, and is technically an instance of Element.

To get a particular attribute without explicitly iterating through the list, call getTableAttribute.

Returns:

List of table's attributes.

Throws:

java.lang.Exception

getTableAttribute

public org.jdom2.Element getTableAttribute(java.lang.String attrName)
                                    throws java.lang.Exception

Get a particular attribute element for this TableElement. To get a list of all attributes, call getTableAttributes.

Parameters:

attrName - The attribute name (case sensitive), for example SERVICENAME, SITEORGTYPE, etc.

Returns:

The element that represents that attribute; null if attribute does not exist.

Throws:

java.lang.Exception

getColumns

public java.util.List getColumns()
                          throws java.lang.Exception

Get the columns for this table. To get a particular column without explicitly iterating through the list, call getColumn.

Returns:

List of child ColumnElements. If no column elements, returns an empty list.

Throws:

java.lang.Exception

getColumn

public ColumnElement getColumn(java.lang.String colName)
                        throws java.lang.Exception

Get a particular ColumnElement for this TableElement. To get a list of all columns, call getColumns.

Parameters:

colName - The column name (case sensitive), for example EQNUM, ITEMNUM, etc.

Returns:

The element that represents that column; null if column does not exist.

Throws:

java.lang.Exception

getAddSql

public java.util.ArrayList getAddSql(java.lang.String tbname,
                                     java.sql.Connection con,
                                     Util util,
                                     java.util.HashMap oldTable)
                              throws java.lang.Exception

When reading XML, called from psdi.upgrade.Upgrade#Upgrade. This method outputs the Sql to add new tables and views or update existing in preparation for running ConfigDB. Any new columns that require a value will be added here as not required, then modified to required in TableElement.getUpdateSql(String, Connection, Util, HashMap). Any required columns that are to be dropped will be marked as not required, then dropped in TableElement.getUpdateSql(String, Connection, Util, HashMap).

Parameters:

tbname - The table name.

con - The connection to the database being upgraded.

util - Reference to the Util class.

oldTable - The current attributes for the table and columns, before being upgraded.

Returns:

Series of sql statements

Throws:

java.lang.Exception

See Also:

TableElement.addTableCfg(), TableElement.updateTableCfg(), TableElement.getNewHashmap(java.util.HashMap, boolean), TableElement.getFormatValue(java.lang.String, java.lang.String), ColumnElement.getAddSql(String, String, Connection, Util, HashMap, TableElement)

getUpdateSql

public java.util.ArrayList getUpdateSql(java.lang.String tbname,
                                        java.sql.Connection con,
                                        Util util,
                                        java.util.HashMap oldTable)
                                 throws java.lang.Exception

When reading XML, called from Upgrade. This method outputs the Sql to update or delete existing tables and columns in preparation for running ConfigDB.

Parameters:

tbname - The table name.

con - The connection to the database being upgraded.

util - Reference to the Util class.

oldTable - The current attributes for the table and columns, before being upgraded.

Returns:

Series of sql statements

Throws:

java.lang.Exception

See Also:

TableElement.addTableCfg(), TableElement.updateTableCfg(), TableElement.getNewHashmap(java.util.HashMap, boolean), TableElement.getFormatValue(java.lang.String, java.lang.String), ColumnElement.getUpdateSql(java.lang.String, java.lang.String, java.sql.Connection, psdi.configure.Util, java.util.HashMap, psdi.configure.TableElement)

getPreDropSql

public java.util.ArrayList getPreDropSql()
                                  throws java.lang.Exception

Prior to dropping a table, update its columns and attributes. Tables are not dropped until late in the upgrade process. In the meantime, the existence of an obsolete table can cause problems. Make sure no upgrade processes act upon an obsolete table.

Returns:

List of SQL stement to execute.

Throws:

java.lang.Exception

getDropIndexesSql

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

Generate SQL to drop indexes for a table. Tables are not dropped until late in the upgrade process. In the meantime, the existence of obsolete indexes can cause problems.

Returns:

SQL statement to execute.

Throws:

java.lang.Exception

getNextAttributeID

protected int getNextAttributeID()

Used when adding new rows to maxattributecfg to get the next value for attributeno. Adds one to attributeno each time it is called.

Returns:

the next attribute number

getNextViewColumnID

protected int getNextViewColumnID()

Used when adding new rows to maxviewcolumncfg to get the next value for TableElement.viewcolumnno. Adds one to viewcolumnno each time it is called.

Returns:

the next view column number

getNewHashmap

public java.util.HashMap getNewHashmap(java.util.HashMap oldMap,
                                       boolean rebuild)
                                throws java.lang.Exception

This method can be used when reading XML to output a HashMap in the format of Util.getAttributeMeta(String, boolean, boolean, boolean, boolean, boolean, String).

If the "rebuild" parameter is True, this also calls reEvaluateObjectChanged, updates the "CHANGED" value in the map, and updates the "newChanged" variable. This method retrieves but does not rebuild the columns' hashmaps from ColumnElement.

Parameters:

oldMap - The HashMap representing the original values of the column metadata from the customer's database, before applying the XML changes. If this is a new column to be added, then this parameter will be null or empty.

rebuild - True to rebuild the map. When True, reEvaluateObjectChanged is called and lastNewMap is replaced. This does not cause the maps in ColumnElement to be rebuilt.

False to return the most recently built map (lastNewMap).

Returns:

A HashMap like oldMap, but with the new XML changes applied to it.

Throws:

java.lang.Exception

See Also:

ColumnElement.getNewHashmap(java.util.HashMap, boolean), Util.reEvaluateObjectChanged(HashMap, HashMap, boolean, String)

toHashmap

public java.util.HashMap toHashmap(java.util.HashMap oldMap)
                            throws java.lang.Exception

This method can be used when reading XML to output a HashMap in the format of getObjectMeta.

Parameters:

oldMap - The HashMap representing the original values of the table metadata from the customer's database, before applying the XML changes. If this is a new table to be added, then this parameter will be null or empty.

Returns:

A HashMap like oldMap, but with the new XML changes applied to it.

Throws:

java.lang.Exception

See Also:

ColumnElement.toHashmap(java.util.HashMap)

getNextVal

public int getNextVal(java.lang.String tableName,
                      java.lang.String columnName)
               throws java.lang.Exception

Get the next sequential value for a column. Get the current highest value and add 1.

Parameters:

tableName - Name of the table

columnName - Name of the column

Returns:

The next value to be assigned to the column.

Throws:

java.lang.Exception

adjustView

public java.util.ArrayList adjustView(java.util.HashMap baseTable,
                                      Util util)
                               throws java.lang.Exception

Verify that all views are defined correctly, including:

• autoselect views must view all columns on the table
• if a column is required, view of column must be required

Parameters:

view - A view that extends this table

Returns:

List of SQL commands to adjust the view definition.

Throws:

java.lang.Exception

getUpdateCount

public int getUpdateCount()
                   throws java.lang.Exception

When validating the XML against the database, determine the number of attributes that are being updated for a table and its columns. This count excludes maxobjectid, maxtableid, and maxviewid. Called from validateTable.

Returns:

Number of attributes being updated.

Throws:

java.lang.Exception