com.ibm.tivoli.maximo.oslc.provider

Class OslcJSONStructureObject

java.lang.Object

psdi.iface.mic.StructureObject

psdi.iface.mic.StructureData

com.ibm.tivoli.maximo.oslc.provider.OslcJSONStructureObject

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

OslcJSONStructureData

public class OslcJSONStructureObject
extends StructureData

Structure Object. Used to work with individual level

Version:

1.0

Author:

Boris Dozortsev

Field Summary

Fields inherited from class psdi.iface.mic.StructureObject

XSI_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
OslcJSONStructureObject()
OslcJSONStructureObject(org.jdom.Document input) Construct the StructureData object with a prepared document.
OslcJSONStructureObject(org.jdom.Element data) Construct the Structure Object object.
OslcJSONStructureObject(com.ibm.json.java.JSONObject data, java.lang.String mosName, java.lang.String path, java.lang.String messageType, UserInfo userInfo) Construct the StructureData object with a byte array.
OslcJSONStructureObject(java.lang.String operaton, java.lang.String osName, java.lang.String lang, int size, boolean isEvent, boolean isResponse) Construct the StructureData object.

Method Summary

Methods

Modifier and Type	Method and Description
void	createChildrenData(java.lang.String name) Create Child level from current level
java.lang.String	getAttr(java.lang.String attr) Return Attribute Value from current level if Attribute found else return null
java.lang.String	getAttr(java.lang.String col, java.lang.String attr) Return Attribute Value if Attribute found else return null
java.util.List	getChildrenData() Get child Elements as a list
java.util.List	getChildrenData(java.lang.String childPath) Get list of Elements for the given tag name
java.lang.String	getCurrentAction() Return value for the current level action
org.jdom.Element	getCurrentData() Return currentData Element
java.lang.String	getCurrentData(java.lang.String col) Return value for the column name in CurrentData Element as String Value
java.lang.String	getCurrentDataAsBinaryText(java.lang.String col) Return value for the column name in CurrentData Element as binary text
boolean	getCurrentDataAsBoolean(java.lang.String col) Return value for the column name in CurrentData Element as boolean
byte[]	getCurrentDataAsBytes(java.lang.String col) Return value for the column name in CurrentData Element as byte Value
java.util.Date	getCurrentDataAsDate(java.lang.String col) Return value for the column name in CurrentData Element as date
double	getCurrentDataAsDouble(java.lang.String col) Return value for the column name in CurrentData Element as double
org.jdom.Element	getCurrentDataAsElement(java.lang.String key) Return value for the column name in CurrentData Element as Element object
int	getCurrentDataAsInt(java.lang.String col) Return value for the column name in CurrentData Element as integer
java.util.List	getCurrentDataAsList(java.lang.String key) Return value for the column name in CurrentData Element as Element Array object
long	getCurrentDataAsLong(java.lang.String col) Return value for the column name in CurrentData Element as long
java.lang.String	getCurrentDataAsString(java.lang.String col) Return value for the column name in CurrentData Element as String Value
java.lang.String	getCurrentNamespacePrefix() Return current namespace value
java.lang.String	getCurrentNamespaceURI() Return current namespace URI value
StructureObject	getCurrentObject() Return Main MBO which associated with current noun
java.lang.String	getGL(java.lang.String col) Return value for the GL column name in CurrentData Element as String Value
java.lang.String	getGL(java.lang.String col, java.lang.String orgId) Return value for the GL column name in CurrentData Element as String Value
java.lang.String	getGLComponent(java.lang.String col, int order, java.lang.String orgId) Return value GL component for the specified order
java.lang.String	getName() Get Name of the Element
java.util.Map<java.lang.String,java.lang.String>	getNamespaces() Get Map of all namespaces
java.lang.String	getObjectPath() Get Object Path of the object
int	getOverrideType(java.lang.String col, int currentType) Return current type of the field
org.jdom.Element	getParentData() Return parentData Element
java.lang.String	getParentData(java.lang.String col) Return value for the column name from the parent Data Element as String Value
java.lang.String	getRowStamp() Return value for the column name in CurrentData Element as String Value
UserInfo	getUserInfo() Get User Info object
boolean	hasChildren() Get child Elements as a list
boolean	hasDetailData(java.lang.String childPath) Return TRUE or FALSE depending of null value in the column
boolean	isCurrentActionNull() Determine whether Action of the current data of Structure Object is null
boolean	isCurrentDataChanged(java.lang.String col) Return TRUE or FALSE depending of null value in the column
boolean	isCurrentDataNull(java.lang.String col) Return TRUE or FALSE depending of null value in the column
boolean	isGLDataNull(java.lang.String col) Return TRUE or FALSE depending of null value in the GL column
boolean	isGLDataNull(java.lang.String col, java.lang.String orgId) Return TRUE or FALSE depending of null value in the GL column
boolean	isInCurrentData(java.lang.String col) Return TRUE or FALSE depending of null value in the column
void	removeChildData(java.lang.String childName, int index) Remove the specified child of the CurrentData Element at the specified index.
void	removeChildren(java.lang.String childName) Remove the specified child of the CurrentData Element
void	removeFromCurrentData(java.lang.String col) Remove a column from the current data
void	setCurrentAction(java.lang.String action) Set current Element action
void	setCurrentData(java.lang.String colname, byte[] data) Put element to Current Data Element object as bytes
void	setCurrentData(java.lang.String colname, java.util.Date data) Put element to Current Data Element object as date
void	setCurrentData(java.lang.String colname, double data) Put element to Current Data Element object as double
void	setCurrentData(java.lang.String colname, int data) Put element to Current Data Element object as integer
void	setCurrentData(java.lang.String colname, long data) Put element to Current Data Element object as long
void	setCurrentData(java.lang.String colname, java.lang.String data) Add element to Current Data Element object as string
void	setCurrentDataNull(java.lang.String colname) Set data in curent data to null
void	setCurrentNamespace(java.lang.String pref, java.lang.String uri) Srt current namespace value
void	setGL(java.lang.String colname, java.lang.String glString) Construct and set the GLAccount from the given gl string
void	setGL(java.lang.String colname, java.lang.String[] glSegments, java.lang.String orgId) Construct and set the GLAccount from the given gl segments
void	setNamespaces(java.lang.String key, java.lang.String data) Set Map of all namespaces
void	setXPathData(java.lang.String xPathExpression, java.lang.String data) Get Data using XPath expression
java.lang.String	toString() return a string for structure to be able to use the structure as a string anywhere such as in System.out.println

Methods inherited from class psdi.iface.mic.StructureData

addIntObject, addObjectStructure, breakData, breakIntObject, breakObjectStructure, clear, clone, createChildrenData, getAction, getBuild, getCurrentMbo, getCurrentPosition, getData, getDataAsBytes, getDbBuild, getHierarchyObjectList, getIntObjectList, getLanguage, getMajorVersion, getMboArray, getMessageID, getMinorVersion, getOriginalByteData, getPrimaryObject, getPrimaryObjectAsObject, getPrimaryObjectList, getPrimaryObjectName, getRealMbo, getRootName, getSize, getStructureObject, getStructureObject, getStructureObjectList, getTransLanguage, getXPathData, hasDocument, isActionNull, isBroken, isIR, isMultiIntObject, isMultiObjectStructure, isPatch, moveToFirstIntObject, moveToFirstObjectStruture, moveToNextIntObject, moveToNextObjectStructure, moveToPrevIntObject, moveToPrevObjectStructure, removeChildren, removeChildrenFromPrimaryObject, removeCurrentData, removeCurrentIntObject, removeCurrentObjectStructure, setAction, setActionNull, setAsCurrent, setAsCurrent, setAsCurrent, setAsCurrent, setAsCurrent, setChildrenData, setCurrentMbo, setCurrentPosition, setIsPatch, setMboArray, setMessageID, setMicData, setParentAsCurrent, setPrimaryObject, setPrimaryObject, setRealMbo

Methods inherited from class psdi.iface.mic.StructureObject

setGL

Methods inherited from class java.lang.Object

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

Constructor Detail

OslcJSONStructureObject

public OslcJSONStructureObject(java.lang.String operaton,
                       java.lang.String osName,
                       java.lang.String lang,
                       int size,
                       boolean isEvent,
                       boolean isResponse)
                        throws MXException,
                               java.rmi.RemoteException

Construct the StructureData object. This is used to create object structure xml. Used only for internal xml format.

Parameters:

operaton - The operation of the service/channel

osName - The object structure name.

lang - The language of transaction.

size - The object size.

isEvent - Determines if thats an event.

isResponse - Determines if thats a response.

Throws:

MXException, - RemoteException

MXException

java.rmi.RemoteException

OslcJSONStructureObject

public OslcJSONStructureObject(org.jdom.Document input)
                        throws MXException

Construct the StructureData object with a prepared document. It will not break the data. If need to be broken call breakData() method

Parameters:

input - the jdom document

Throws:

MXException

OslcJSONStructureObject

public OslcJSONStructureObject(com.ibm.json.java.JSONObject data,
                       java.lang.String mosName,
                       java.lang.String path,
                       java.lang.String messageType,
                       UserInfo userInfo)

Construct the StructureData object with a byte array. It will not break the data. If need to be broken call breakData() method

Parameters:

data - byte array for the MOS XML

Throws:

MXException

OslcJSONStructureObject

public OslcJSONStructureObject(org.jdom.Element data)

Construct the Structure Object object.

Parameters:

data - Current element.

OslcJSONStructureObject

public OslcJSONStructureObject()

Method Detail

getName

public java.lang.String getName()

Get Name of the Element

Overrides:

getName in class StructureObject

Returns:

name of the element

getObjectPath

public java.lang.String getObjectPath()

Get Object Path of the object

Returns:

object path

getUserInfo

public UserInfo getUserInfo()

Get User Info object

Returns:

user info

createChildrenData

public void createChildrenData(java.lang.String name)

Create Child level from current level

Overrides:

createChildrenData in class StructureObject

Parameters:

name - Name of the child level. This will still maintain the current data pointer to the current level and not move to the child level.

getChildrenData

public java.util.List getChildrenData(java.lang.String childPath)

Get list of Elements for the given tag name

Overrides:

getChildrenData in class StructureObject

Parameters:

tag - The name of the child level.

Returns:

list of Elements for the given tag name

hasDetailData

public boolean hasDetailData(java.lang.String childPath)

Return TRUE or FALSE depending of null value in the column

Overrides:

hasDetailData in class StructureObject

Parameters:

col - Give column name.

Returns:

Indicator for data to be null or not null

getChildrenData

public java.util.List getChildrenData()

Get child Elements as a list

Overrides:

getChildrenData in class StructureData

Returns:

list of Element for children

hasChildren

public boolean hasChildren()

Get child Elements as a list

Overrides:

hasChildren in class StructureObject

Returns:

list of Element for children

isCurrentActionNull

public boolean isCurrentActionNull()

Determine whether Action of the current data of Structure Object is null

Overrides:

isCurrentActionNull in class StructureObject

Returns:

true is Action is null or empty string, false otherwise

getCurrentData

public org.jdom.Element getCurrentData()

Return currentData Element

Overrides:

getCurrentData in class StructureObject

Returns:

Current Element

getCurrentObject

public StructureObject getCurrentObject()

Return Main MBO which associated with current noun

Overrides:

getCurrentObject in class StructureData

Returns:

Current object

getParentData

public org.jdom.Element getParentData()

Return parentData Element

Overrides:

getParentData in class StructureObject

Returns:

Parent object

getAttr

public java.lang.String getAttr(java.lang.String col,
                       java.lang.String attr)

Return Attribute Value if Attribute found else return null

Overrides:

getAttr in class StructureObject

Parameters:

col - Give column name.

attr - Give Attribute name.

Returns:

attribute value

getAttr

public java.lang.String getAttr(java.lang.String attr)

Return Attribute Value from current level if Attribute found else return null

Overrides:

getAttr in class StructureObject

Parameters:

attr - Give Attribute name.

Returns:

attribute value

removeFromCurrentData

public void removeFromCurrentData(java.lang.String col)

Remove a column from the current data

Overrides:

removeFromCurrentData in class StructureObject

Parameters:

col - Give element name to remove.

removeChildData

public void removeChildData(java.lang.String childName,
                   int index)

Remove the specified child of the CurrentData Element at the specified index.

Overrides:

removeChildData in class StructureObject

Parameters:

childName - Give element name to remove.

index - Give index of the element to remove.

removeChildren

public void removeChildren(java.lang.String childName)

Remove the specified child of the CurrentData Element

Overrides:

removeChildren in class StructureObject

Parameters:

childName - Give column name.

getCurrentData

public java.lang.String getCurrentData(java.lang.String col)
                                throws MXException

Return value for the column name in CurrentData Element as String Value

Overrides:

getCurrentData in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level

Throws:

MXException

getRowStamp

public java.lang.String getRowStamp()
                             throws MXException

Return value for the column name in CurrentData Element as String Value

Overrides:

getRowStamp in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level

Throws:

MXException

getCurrentDataAsBytes

public byte[] getCurrentDataAsBytes(java.lang.String col)
                             throws MXException

Return value for the column name in CurrentData Element as byte Value

Overrides:

getCurrentDataAsBytes in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level

Throws:

MXException

getCurrentDataAsBinaryText

public java.lang.String getCurrentDataAsBinaryText(java.lang.String col)
                                            throws MXException

Return value for the column name in CurrentData Element as binary text

Overrides:

getCurrentDataAsBinaryText in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level

Throws:

MXException

getParentData

public java.lang.String getParentData(java.lang.String col)

Return value for the column name from the parent Data Element as String Value

Overrides:

getParentData in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from parent level

isCurrentDataNull

public boolean isCurrentDataNull(java.lang.String col)
                          throws MXException

Return TRUE or FALSE depending of null value in the column

Overrides:

isCurrentDataNull in class StructureObject

Parameters:

col - Give column name.

Returns:

Indicator for data to be null or not null

Throws:

MXException

isGLDataNull

public boolean isGLDataNull(java.lang.String col)
                     throws MXException

Return TRUE or FALSE depending of null value in the GL column

Overrides:

isGLDataNull in class StructureObject

Parameters:

col - Give GL column name.

Returns:

Indicator for data to be null or not null

Throws:

MXException

isGLDataNull

public boolean isGLDataNull(java.lang.String col,
                   java.lang.String orgId)
                     throws MXException

Return TRUE or FALSE depending of null value in the GL column

Overrides:

isGLDataNull in class StructureObject

Parameters:

col - Give GL column name.

orgId - Give organization.

Returns:

Indicator for data to be null or not null

Throws:

MXException

isInCurrentData

public boolean isInCurrentData(java.lang.String col)

Return TRUE or FALSE depending of null value in the column

Overrides:

isInCurrentData in class StructureObject

Parameters:

col - Give column name.

Returns:

Indicator for data to be null or not null

isCurrentDataChanged

public boolean isCurrentDataChanged(java.lang.String col)

Return TRUE or FALSE depending of null value in the column

Overrides:

isCurrentDataChanged in class StructureObject

Parameters:

col - Give column name.

Returns:

Indicator for data to be null or not null

getCurrentDataAsDouble

public double getCurrentDataAsDouble(java.lang.String col)
                              throws MXException

Return value for the column name in CurrentData Element as double

Overrides:

getCurrentDataAsDouble in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level as double

Throws:

MXException

getCurrentDataAsInt

public int getCurrentDataAsInt(java.lang.String col)
                        throws MXException

Return value for the column name in CurrentData Element as integer

Overrides:

getCurrentDataAsInt in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level as integer

Throws:

MXException

getCurrentDataAsLong

public long getCurrentDataAsLong(java.lang.String col)
                          throws MXException

Return value for the column name in CurrentData Element as long

Overrides:

getCurrentDataAsLong in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level as long

Throws:

MXException

getCurrentDataAsDate

public java.util.Date getCurrentDataAsDate(java.lang.String col)
                                    throws MXException

Return value for the column name in CurrentData Element as date

Overrides:

getCurrentDataAsDate in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level as date

Throws:

MXException

getCurrentDataAsBoolean

public boolean getCurrentDataAsBoolean(java.lang.String col)
                                throws MXException

Return value for the column name in CurrentData Element as boolean

Overrides:

getCurrentDataAsBoolean in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level as boolean

Throws:

MXException

getCurrentDataAsElement

public org.jdom.Element getCurrentDataAsElement(java.lang.String key)

Return value for the column name in CurrentData Element as Element object

Overrides:

getCurrentDataAsElement in class StructureObject

Parameters:

key - Give key name.

Returns:

Column value from current level as Element object

getCurrentDataAsList

public java.util.List getCurrentDataAsList(java.lang.String key)

Return value for the column name in CurrentData Element as Element Array object

Overrides:

getCurrentDataAsList in class StructureObject

Parameters:

key - Give key name.

Returns:

Column value from current level as Element Array object

getGL

public java.lang.String getGL(java.lang.String col)
                       throws MXException

Return value for the GL column name in CurrentData Element as String Value

Overrides:

getGL in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level

Throws:

MXException

getGL

public java.lang.String getGL(java.lang.String col,
                     java.lang.String orgId)
                       throws MXException

Return value for the GL column name in CurrentData Element as String Value

Overrides:

getGL in class StructureObject

Parameters:

col - Give column name.

orgId - Give organization.

Returns:

Column value from current level

Throws:

MXException

getGLComponent

public java.lang.String getGLComponent(java.lang.String col,
                              int order,
                              java.lang.String orgId)
                                throws MXException

Return value GL component for the specified order

Overrides:

getGLComponent in class StructureObject

Parameters:

col - Give column name.

order - GL order.

orgId - the ORGID.

Returns:

Column value from current level

Throws:

MXException

getCurrentAction

public java.lang.String getCurrentAction()

Return value for the current level action

Overrides:

getCurrentAction in class StructureObject

Returns:

in CurrentData Element as String Value

setCurrentData

public void setCurrentData(java.lang.String colname,
                  java.lang.String data)

Add element to Current Data Element object as string

Overrides:

setCurrentData in class StructureObject

Parameters:

col - Give column name.

data - Give column value as string.

setCurrentAction

public void setCurrentAction(java.lang.String action)

Set current Element action

Overrides:

setCurrentAction in class StructureObject

Parameters:

action - action value to be set.

setCurrentDataNull

public void setCurrentDataNull(java.lang.String colname)

Set data in curent data to null

Overrides:

setCurrentDataNull in class StructureObject

Parameters:

colname - Give column name.

setCurrentData

public void setCurrentData(java.lang.String colname,
                  java.util.Date data)

Put element to Current Data Element object as date

Overrides:

setCurrentData in class StructureObject

Parameters:

colname - Give column name.

data - Give column value as date.

setCurrentData

public void setCurrentData(java.lang.String colname,
                  double data)

Put element to Current Data Element object as double

Overrides:

setCurrentData in class StructureObject

Parameters:

colname - Give column name.

data - Give column value as double.

setCurrentData

public void setCurrentData(java.lang.String colname,
                  long data)

Put element to Current Data Element object as long

Overrides:

setCurrentData in class StructureObject

Parameters:

colname - Give column name.

data - Give column value as long.

setCurrentData

public void setCurrentData(java.lang.String colname,
                  int data)

Put element to Current Data Element object as integer

Overrides:

setCurrentData in class StructureObject

Parameters:

colname - Give column name.

data - Give column value as integer.

setCurrentData

public void setCurrentData(java.lang.String colname,
                  byte[] data)
                    throws MXException

Put element to Current Data Element object as bytes

Overrides:

setCurrentData in class StructureObject

Parameters:

colname - Give column name.

data - Give column value as bytes.

Throws:

MXException

setGL

public void setGL(java.lang.String colname,
         java.lang.String[] glSegments,
         java.lang.String orgId)
           throws MXException

Construct and set the GLAccount from the given gl segments

Overrides:

setGL in class StructureObject

Parameters:

colname - the column name

glSegments - the gl segments array

orgId - the organization

Throws:

MXException

setGL

public void setGL(java.lang.String colname,
         java.lang.String glString)

Construct and set the GLAccount from the given gl string

Overrides:

setGL in class StructureObject

Parameters:

colname - the column name

glString - the gl segments array

setXPathData

public void setXPathData(java.lang.String xPathExpression,
                java.lang.String data)
                  throws MXException

Get Data using XPath expression

Overrides:

setXPathData in class StructureObject

Throws:

MXException

getCurrentDataAsString

public java.lang.String getCurrentDataAsString(java.lang.String col)
                                        throws MXException

Return value for the column name in CurrentData Element as String Value

Overrides:

getCurrentDataAsString in class StructureObject

Parameters:

col - Give column name.

Returns:

Column value from current level

Throws:

MXException

getCurrentNamespacePrefix

public java.lang.String getCurrentNamespacePrefix()

Return current namespace value

Overrides:

getCurrentNamespacePrefix in class StructureObject

Returns:

Current Namespace prefix value

getCurrentNamespaceURI

public java.lang.String getCurrentNamespaceURI()

Return current namespace URI value

Overrides:

getCurrentNamespaceURI in class StructureObject

Returns:

Current Namespace value

setCurrentNamespace

public void setCurrentNamespace(java.lang.String pref,
                       java.lang.String uri)

Srt current namespace value

Overrides:

setCurrentNamespace in class StructureObject

Parameters:

pref - Give namespace prefix value.

uri - Give namespace uri value.

getNamespaces

public java.util.Map<java.lang.String,java.lang.String> getNamespaces()

Get Map of all namespaces

Overrides:

getNamespaces in class StructureObject

Returns:

map of namespaces

setNamespaces

public void setNamespaces(java.lang.String key,
                 java.lang.String data)

Set Map of all namespaces

Overrides:

setNamespaces in class StructureObject

Parameters:

key - key to access namespace

data - namespace

getOverrideType

public int getOverrideType(java.lang.String col,
                  int currentType)
                    throws MXException

Return current type of the field

Overrides:

getOverrideType in class StructureObject

Parameters:

col - Give column name.

currentType - max type

Returns:

max type.

Throws:

MXException

toString

public java.lang.String toString()

return a string for structure to be able to use the structure as a string anywhere such as in System.out.println

Overrides:

toString in class StructureData