psdi.configure

Class IndexElement

java.lang.Object

org.jdom.Content

org.jdom.Element

psdi.configure.IndexElement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.jdom.Parent, UpgConstants

public class IndexElement
extends org.jdom.Element
implements UpgConstants

Element to represent an index (maxsysindexes and maxsyskeys) in the XML file that is output by BuildUpgMetadata and input to Upgrade. This is an extension of org.jdom.Element.

IndexElement is instanciated by the following:

• When writing XML (BuildUpgMetadata), instanciated from compareIndexMeta and writeOldIndexes. The constructor will populate the IndexElement object appropriately.
• When reading XML (Upgrade), instanciated from ConfigXMLFactory, via Upgrade. The IndexElement methods getAddSql and getDropSql return sql statements for modifying the index metadata prior to running ConfigDB.

See Also:

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

Field Summary

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
IndexElement(java.lang.String name)
IndexElement(java.lang.String name, org.jdom.Namespace namespace)
IndexElement(java.lang.String name, java.lang.String uri)
IndexElement(java.lang.String tbname, java.lang.String ixname, java.util.HashMap newIndex, java.util.HashMap oldIndex) This constructor is used when creating a new IndexElement for the purpose of writing out XML.
IndexElement(java.lang.String name, java.lang.String prefix, java.lang.String uri)

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList	getAddSql(java.lang.String tbname, java.lang.String ixname, java.sql.Connection con, Util util, java.util.HashMap oldIndex) When reading XML, called from Upgrade.
java.lang.String[]	getColNames() Get an array of column names that are in this index.
java.util.ArrayList	getDropSql(java.lang.String tbname, java.lang.String ixname, java.sql.Connection con, Util util, java.util.HashMap oldIndex) When reading XML, called from Upgrade.
java.util.List	getIndexAttributes() Get the attributes for this IndexElement.
java.lang.String	getIndexName() Get the index name.
java.util.List	getKeys() Get the keys for this index.
java.lang.String	getNewChanged() Get the new value for maxsysindexes.changed (newChanged).
java.lang.String	getSequenceName(java.lang.String table, java.lang.String column) Get the name of the sequence used to populate a column.
java.lang.String	getStatus() Get the value of the index's attribute value "status" (see status).
void	setNewChanged(java.lang.String in) Set the new value for maxsysindexes.changed (newChanged).
java.util.HashMap	toHashmap(java.util.HashMap oldMap) This method can be used when reading XML to output a HashMap in the format of getIndexMeta.

Methods inherited from class org.jdom.Element

addContent, addContent, addContent, addContent, addContent, addNamespaceDeclaration, clone, cloneContent, getAdditionalNamespaces, getAttribute, getAttribute, getAttributes, 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, getNamespaceURI, getQualifiedName, getText, getTextNormalize, getTextTrim, getValue, indexOf, isAncestor, isRootElement, removeAttribute, removeAttribute, removeAttribute, removeChild, removeChild, removeChildren, removeChildren, removeContent, removeContent, removeContent, removeContent, removeNamespaceDeclaration, setAttribute, setAttribute, setAttribute, setAttributes, setAttributes, setContent, setContent, setContent, setContent, setName, setNamespace, setText, toString

Methods inherited from class org.jdom.Content

detach, equals, getDocument, getParent, getParentElement, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jdom.Parent

getDocument, getParent

Constructor Detail

IndexElement

public IndexElement(java.lang.String name,
                    org.jdom.Namespace namespace)

IndexElement

public IndexElement(java.lang.String name)

IndexElement

public IndexElement(java.lang.String name,
                    java.lang.String uri)

IndexElement

public IndexElement(java.lang.String name,
                    java.lang.String prefix,
                    java.lang.String uri)

IndexElement

public IndexElement(java.lang.String tbname,
                    java.lang.String ixname,
                    java.util.HashMap newIndex,
                    java.util.HashMap oldIndex)
             throws java.lang.Exception

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

Parameters:

tbname - The table name

ixname - The index name

newIndex - The index from the new database.

oldIndex - The index from the old database.

Throws:

java.lang.Exception

See Also:

buildFromHashMaps()

Method Detail

getIndexName

public java.lang.String getIndexName()

Get the index name.

Returns:

The index name.

getIndexAttributes

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

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

Returns:

List of index's attributes.

Throws:

java.lang.Exception

getKeys

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

Get the keys for this index.

Returns:

List of child keys.

Throws:

java.lang.Exception

getColNames

public java.lang.String[] getColNames()
                               throws java.lang.Exception

Get an array of column names that are in this index.

Returns:

Array of column names. If index status is OLDONLY, these are the "old" column names, else these are the "new" column names.

Throws:

java.lang.Exception

getAddSql

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

When reading XML, called from Upgrade. This method outputs the Sql to update the customer's metadata in preparation for running ConfigDB.

Parameters:

tbname - The table name.

ixname - The index name.

con - The connection to the database being upgraded.

util - Reference to the Util class.

oldIndex - No longer used.

Returns:

Series of sql statements to add or update an index.

Throws:

java.lang.Exception

See Also:

getNewIxname(java.lang.String), addIndexCfg(java.lang.String, java.util.TreeMap), getFormatValue(java.lang.String, java.lang.String)

getDropSql

public java.util.ArrayList getDropSql(java.lang.String tbname,
                                      java.lang.String ixname,
                                      java.sql.Connection con,
                                      Util util,
                                      java.util.HashMap oldIndex)
                               throws java.lang.Exception

When reading XML, called from Upgrade. This method outputs the Sql to update the customer's metadata in preparation for running ConfigDB.

Parameters:

tbname - The table name.

ixname - The index name.

con - The connection to the database being upgraded.

util - Reference to the Util class.

oldIndex - The current attributes for the index, before being upgraded.

Returns:

Series of sql statements

Throws:

java.lang.Exception

See Also:

getNewIxname(java.lang.String), addIndexCfg(java.lang.String, java.util.TreeMap), getFormatValue(java.lang.String, java.lang.String)

getStatus

public java.lang.String getStatus()

Get the value of the index's attribute value "status" (see status). This will equal OLDONLY, NEWONLY, or OLDANDNEW to indicate whether the index 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 maxsysindexes.changed (newChanged).

Returns:

The new value for changed.

setNewChanged

public void setNewChanged(java.lang.String in)

Set the new value for maxsysindexes.changed (newChanged). Possible values on the index are:

• N = no changes
• D = drop index
• Y = new (or changed) index

Parameters:

in - The new value for changed.

getSequenceName

public java.lang.String getSequenceName(java.lang.String table,
                                        java.lang.String column)
                                 throws java.lang.Exception

Get the name of the sequence used to populate a column. Select SequenceName from MaxSequence.

Parameters:

table - Name of the table

column - Name of the column

Returns:

Name of the sequence; null if no sequence exists for the column

Throws:

java.lang.Exception

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 getIndexMeta.

Parameters:

oldMap - The HashMap representing the original values of the index metadata from the customer's database, before applying the XML changes. If this is a new index 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