com.ibm.tivoli.maximo.oslc.provider

Class OslcJSONStructureData

java.lang.Object

psdi.iface.mic.StructureObject

psdi.iface.mic.StructureData

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

com.ibm.tivoli.maximo.oslc.provider.OslcJSONStructureData

All Implemented Interfaces:

java.lang.Cloneable

public class OslcJSONStructureData
extends OslcJSONStructureObject

OSLC JSON Structure Data. It's a wrapper class around document to travel thru the data.

Version:

1.0

Author:

Boris Dozortsev

Field Summary

Fields inherited from class psdi.iface.mic.StructureObject

XSI_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
OslcJSONStructureData(com.ibm.json.java.JSONObject data, java.lang.String mosName, java.lang.String path, UserInfo userInfo, java.lang.String messageType) Construct the StructureData object with a byte array.

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectStructure() Adds object structure to the list of existing os records
void	breakData() Parses channel/ service document data and sets corresponding object variables.
void	breakObjectStructure() Parses object structure and sets global variables.
java.lang.Object	clone() clones the StructureData object and the document inside it.
void	createChildrenData(java.lang.String name, boolean setAsCurrent) Create Child level from current level
java.lang.String	getAction() Get Action of the Structure Data
java.lang.String	getBuild() Gets a build number
java.lang.String	getCurrentAction() Return value for the current level action
StructureObject	getCurrentObject() Return Main MBO which associated with current noun
int	getCurrentPosition() gets current position
org.jdom.Document	getData() Return data in jdom Document format
byte[]	getDataAsBytes() Return the whole document as bytes.
java.util.List	getHierarchyObjectList() Get list of hierarchy objects in mos in the Structure data
java.lang.String	getLanguage() Get base language of the Maximo.
java.lang.String	getMessageID() Get Message ID of the Structure Data
byte[]	getOriginalByteData() Return the whole document as bytes.
org.jdom.Element	getPrimaryObject() Get primary object in the current level
java.lang.Object	getPrimaryObjectAsObject() Get primary object in the current level
java.util.List	getPrimaryObjectList() Get list of primary objects in mos in the Structure data
java.lang.String	getPrimaryObjectName() Get main object name in the Structure data (it can be alias)
java.lang.String	getRootName() gets root element name
int	getSize() Get the object structure size
StructureObject	getStructureObject(int pos) Get object structure in the current level
StructureObject	getStructureObject(java.lang.String xPathExpression) Get StructureObject using XPath expression
java.util.List	getStructureObjectList(java.lang.String xPathExpression) Get List of objects using XPath expression
java.lang.String	getTransLanguage() Get language of the transaction.
java.lang.String	getXPathData(java.lang.String xPathExpression) Get Data using XPath expression
boolean	hasDocument() Determines if the StructureData instance has the data converted to a Document or is still in bytes format.
boolean	isActionNull() Determine whether Action of primary object of Structure Data is null
boolean	isBroken() Determine is data broken or not.
boolean	isMultiObjectStructure() checks whether XML has multiple object structures
void	moveToFirstObjectStruture() Reset Structure Data to point to first object structure.
boolean	moveToNextObjectStructure() moves to the next object structure .
boolean	moveToPrevObjectStructure() moves to the previous object structure.
void	removeChildrenFromPrimaryObject() Remove all children of the Primary Object Element
void	removeCurrentData() Remove the CurrentData Element and set the parent as the current data
void	removeCurrentObjectStructure() Removed the current object structure from the Structure & re-positions cursor to previous one.
void	setAction(java.lang.String action) Set object Element action
void	setActionNull() Set object Element action to null
StructureObject	setAsCurrent() Sets current data
StructureObject	setAsCurrent(org.jdom.Element data) Set Element as the current level
void	setAsCurrent(java.util.List data, int i) Set Element of the list as the current level
StructureObject	setAsCurrent(java.lang.Object data) Set Element as the current level
StructureObject	setAsCurrent(java.lang.String xPathExpression) Sets current data
void	setChildrenData(java.util.List<org.jdom.Element> l) Set child level data
void	setCurrentPosition(int pos) Sets current position
void	setMessageID(java.lang.String id) Set message id
StructureObject	setMicData(org.jdom.Element data) Set Element in the current element
boolean	setParentAsCurrent() Set parent Element as current data.
void	setPrimaryObject(org.jdom.Element h) Set Primary Object Element object
void	setPrimaryObject(java.lang.String name) Set the primary object
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 com.ibm.tivoli.maximo.oslc.provider.OslcJSONStructureObject

createChildrenData, getAttr, getAttr, getChildrenData, getChildrenData, getCurrentData, getCurrentData, getCurrentDataAsBinaryText, getCurrentDataAsBoolean, getCurrentDataAsBytes, getCurrentDataAsDate, getCurrentDataAsDouble, getCurrentDataAsElement, getCurrentDataAsInt, getCurrentDataAsList, getCurrentDataAsLong, getCurrentDataAsString, getCurrentNamespacePrefix, getCurrentNamespaceURI, getGL, getGL, getGLComponent, getName, getNamespaces, getObjectPath, getOverrideType, getParentData, getParentData, getRowStamp, getUserInfo, hasChildren, hasDetailData, isCurrentActionNull, isCurrentDataChanged, isCurrentDataNull, isGLDataNull, isGLDataNull, isInCurrentData, removeChildData, removeChildren, removeFromCurrentData, setCurrentAction, setCurrentData, setCurrentData, setCurrentData, setCurrentData, setCurrentData, setCurrentData, setCurrentDataNull, setCurrentNamespace, setGL, setGL, setNamespaces, setXPathData

Methods inherited from class psdi.iface.mic.StructureData

addIntObject, breakIntObject, clear, getCurrentMbo, getDbBuild, getIntObjectList, getMajorVersion, getMboArray, getMinorVersion, getRealMbo, isIR, isMultiIntObject, isPatch, moveToFirstIntObject, moveToNextIntObject, moveToPrevIntObject, removeChildren, removeCurrentIntObject, setCurrentMbo, setIsPatch, setMboArray, 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

OslcJSONStructureData

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

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

Method Detail

isBroken

public boolean isBroken()

Determine is data broken or not.

Overrides:

isBroken in class StructureData

Returns:

boolean is xml broken

addObjectStructure

public void addObjectStructure()
                        throws MXException

Adds object structure to the list of existing os records

Overrides:

addObjectStructure in class StructureData

Throws:

MXException

moveToNextObjectStructure

public boolean moveToNextObjectStructure()
                                  throws MXException

moves to the next object structure . This call will break the data for that object structure and will set the current data pointer. This method should be called only for internal xmls.

Overrides:

moveToNextObjectStructure in class StructureData

Returns:

boolean if last object or not

Throws:

MXException

moveToPrevObjectStructure

public boolean moveToPrevObjectStructure()
                                  throws MXException

moves to the previous object structure. This call will break the data for that object structure and will set the current data pointer. This method should be called only for internal xmls.

Overrides:

moveToPrevObjectStructure in class StructureData

Returns:

boolean if first object or not

Throws:

MXException

moveToFirstObjectStruture

public void moveToFirstObjectStruture()
                               throws MXException

Reset Structure Data to point to first object structure. This will change the current data pointer and break that data.

Overrides:

moveToFirstObjectStruture in class StructureData

Throws:

MXException

removeCurrentObjectStructure

public void removeCurrentObjectStructure()
                                  throws MXException

Removed the current object structure from the Structure & re-positions cursor to previous one. If current position is 0 (i.e no integration objects exist after removal of the current mos), then currentPosition will point to -1 and currentData will point to null after removal of the current os.

Overrides:

removeCurrentObjectStructure in class StructureData

Throws:

MXException

removeChildrenFromPrimaryObject

public void removeChildrenFromPrimaryObject()
                                     throws java.rmi.RemoteException,
                                            MXException

Remove all children of the Primary Object Element

Overrides:

removeChildrenFromPrimaryObject in class StructureData

Throws:

MXException

java.rmi.RemoteException

getData

public org.jdom.Document getData()

Return data in jdom Document format

Overrides:

getData in class StructureData

Returns:

Document object with whole data which is stored in StructureData object

hasDocument

public boolean hasDocument()

Determines if the StructureData instance has the data converted to a Document or is still in bytes format.

Overrides:

hasDocument in class StructureData

Returns:

true is the data is converted to a Document object and false otherwise

getDataAsBytes

public byte[] getDataAsBytes()

Return the whole document as bytes. This is costly method as it regenerates the byte data from the document each time the call is made.

Overrides:

getDataAsBytes in class StructureData

Returns:

byte[] whole data which is stored in StructureData object

getOriginalByteData

public byte[] getOriginalByteData()

Return the whole document as bytes. This is costly method as it regenerates the byte data from the document each time the call is made.

Overrides:

getOriginalByteData in class StructureData

Returns:

byte[] whole data which is stored in StructureData object

clone

public java.lang.Object clone()

clones the StructureData object and the document inside it.

Overrides:

clone in class StructureData

Returns:

Object a copy of the StructureData object

breakData

public void breakData()
               throws MXException

Parses channel/ service document data and sets corresponding object variables.

Overrides:

breakData in class StructureData

Throws:

MXException

breakObjectStructure

public void breakObjectStructure()
                          throws MXException

Parses object structure and sets global variables.

Overrides:

breakObjectStructure in class StructureData

Throws:

MXException

setMicData

public StructureObject setMicData(org.jdom.Element data)

Set Element in the current element

Overrides:

setMicData in class StructureData

Parameters:

data - Give reference Element to set to current level.

Returns:

Structure Object which is a wrapper around one Element

createChildrenData

public void createChildrenData(java.lang.String name,
                      boolean setAsCurrent)

Create Child level from current level

Overrides:

createChildrenData in class StructureData

Parameters:

name - Name of the child level. This will move the current data pointer to the child level.

setAsCurrent - boolean to identify setting child as current level or not

setParentAsCurrent

public boolean setParentAsCurrent()

Set parent Element as current data.

Overrides:

setParentAsCurrent in class StructureData

Returns:

boolean If there is no parent returns false otherwise true and sets the current data pointer to the parent.

getPrimaryObjectList

public java.util.List getPrimaryObjectList()

Get list of primary objects in mos in the Structure data

Overrides:

getPrimaryObjectList in class StructureData

Returns:

list of object structures as Elements in the Structure data

getHierarchyObjectList

public java.util.List getHierarchyObjectList()

Get list of hierarchy objects in mos in the Structure data

Overrides:

getHierarchyObjectList in class StructureData

Returns:

list of object structures as Elements in the Structure data

getSize

public int getSize()

Get the object structure size

Overrides:

getSize in class StructureData

Returns:

size of the object structure

isMultiObjectStructure

public boolean isMultiObjectStructure()

checks whether XML has multiple object structures

Overrides:

isMultiObjectStructure in class StructureData

Returns:

whether XML has multiple object structures

getPrimaryObjectName

public java.lang.String getPrimaryObjectName()

Get main object name in the Structure data (it can be alias)

Overrides:

getPrimaryObjectName in class StructureData

Returns:

main object name in the Structure data (it can be alias)

getLanguage

public java.lang.String getLanguage()
                             throws MXException

Get base language of the Maximo.

Overrides:

getLanguage in class StructureData

Returns:

Base Language of the Maximo

Throws:

MXException

getTransLanguage

public java.lang.String getTransLanguage()
                                  throws MXException

Get language of the transaction. If language is not set up for for the transaction will use local language

Overrides:

getTransLanguage in class StructureData

Returns:

Language of the transaction

Throws:

MXException

getPrimaryObject

public org.jdom.Element getPrimaryObject()

Get primary object in the current level

Overrides:

getPrimaryObject in class StructureData

Returns:

Reference to Element object with a primary object data

getPrimaryObjectAsObject

public java.lang.Object getPrimaryObjectAsObject()
                                          throws MXException

Get primary object in the current level

Overrides:

getPrimaryObjectAsObject in class StructureData

Returns:

Reference to Element object with a primary object data

Throws:

MXException

getStructureObject

public StructureObject getStructureObject(int pos)

Get object structure in the current level

Overrides:

getStructureObject in class StructureData

Parameters:

pos - Position of the object structure in the list.

Returns:

Reference to Element object with a data

getAction

public java.lang.String getAction()

Get Action of the Structure Data

Overrides:

getAction in class StructureData

Returns:

Action of the Structure Data

isActionNull

public boolean isActionNull()

Determine whether Action of primary object of Structure Data is null

Overrides:

isActionNull in class StructureData

Returns:

true is Action is null or empty string, false otherwise

getMessageID

public java.lang.String getMessageID()

Get Message ID of the Structure Data

Overrides:

getMessageID in class StructureData

removeCurrentData

public void removeCurrentData()

Remove the CurrentData Element and set the parent as the current data

Overrides:

removeCurrentData in class StructureData

setPrimaryObject

public void setPrimaryObject(org.jdom.Element h)

Set Primary Object Element object

Overrides:

setPrimaryObject in class StructureData

Parameters:

h - Give reference Element to set to primary object.

setPrimaryObject

public void setPrimaryObject(java.lang.String name)

Set the primary object

Overrides:

setPrimaryObject in class StructureData

Parameters:

name - name of the primary object

setCurrentPosition

public void setCurrentPosition(int pos)

Sets current position

Overrides:

setCurrentPosition in class StructureData

Parameters:

pos - Position of the object strucure in the list.

getCurrentPosition

public int getCurrentPosition()

gets current position

Overrides:

getCurrentPosition in class StructureData

Returns:

pos Position of the object structure in the list.

getRootName

public java.lang.String getRootName()

gets root element name

Overrides:

getRootName in class StructureData

Returns:

name of root element.

setAction

public void setAction(java.lang.String action)

Set object Element action

Overrides:

setAction in class StructureData

Parameters:

action - action value to be set.

setActionNull

public void setActionNull()

Set object Element action to null

Overrides:

setActionNull in class StructureData

setChildrenData

public void setChildrenData(java.util.List<org.jdom.Element> l)

Set child level data

Overrides:

setChildrenData in class StructureData

Parameters:

l - Give reference to List of Element to set as child.

setAsCurrent

public StructureObject setAsCurrent(org.jdom.Element data)

Set Element as the current level

Overrides:

setAsCurrent in class StructureData

Parameters:

data - Give reference to Element to set as current.

setAsCurrent

public StructureObject setAsCurrent(java.lang.Object data)

Set Element as the current level

Overrides:

setAsCurrent in class StructureData

Parameters:

data - Give reference to Element to set as current.

setAsCurrent

public void setAsCurrent(java.util.List data,
                int i)

Set Element of the list as the current level

Overrides:

setAsCurrent in class StructureData

Parameters:

i - the index.

setAsCurrent

public StructureObject setAsCurrent()

Sets current data

Overrides:

setAsCurrent in class StructureData

Returns:

Return current data as struture object.

setAsCurrent

public StructureObject setAsCurrent(java.lang.String xPathExpression)
                             throws MXException

Sets current data

Overrides:

setAsCurrent in class StructureData

Parameters:

xPathExpression - Give XPath expression.

Returns:

Return data as structure object.

Throws:

MXException

getStructureObject

public StructureObject getStructureObject(java.lang.String xPathExpression)
                                   throws MXException

Get StructureObject using XPath expression

Overrides:

getStructureObject in class StructureData

Parameters:

xPathExpression - Give XPath expression.

Returns:

Return data as structure object.

Throws:

MXException

getXPathData

public java.lang.String getXPathData(java.lang.String xPathExpression)
                              throws MXException

Get Data using XPath expression

Overrides:

getXPathData in class StructureData

Returns:

Return value of XML field.

Throws:

MXException

getStructureObjectList

public java.util.List getStructureObjectList(java.lang.String xPathExpression)
                                      throws MXException

Get List of objects using XPath expression

Overrides:

getStructureObjectList in class StructureData

Returns:

Return list of structure object.

Throws:

MXException

setMessageID

public void setMessageID(java.lang.String id)

Set message id

Overrides:

setMessageID in class StructureData

getBuild

public java.lang.String getBuild()

Gets a build number

Overrides:

getBuild in class StructureData

Returns:

the MAXIMO build number.

getCurrentObject

public StructureObject getCurrentObject()

Return Main MBO which associated with current noun

Overrides:

getCurrentObject in class OslcJSONStructureObject

Returns:

Current object

getCurrentAction

public java.lang.String getCurrentAction()

Return value for the current level action

Overrides:

getCurrentAction in class OslcJSONStructureObject

Returns:

in CurrentData Element as String Value

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 OslcJSONStructureObject