public class StructureData extends StructureObject implements java.lang.Cloneable
XSI_NAMESPACE
Constructor and Description |
---|
StructureData()
Default constructor.
|
StructureData(byte[] data)
Construct the StructureData object with a byte array.
|
StructureData(org.jdom.Document input)
Construct the StructureData object with a prepared document.
|
StructureData(java.lang.String data)
Construct the StructureData object with a string.
|
StructureData(java.lang.String operaton,
java.lang.String osName,
java.lang.String lang,
int size,
boolean isEvent,
boolean isResponse)
Construct the StructureData object.
|
Modifier and Type | Method and Description |
---|---|
void |
addIntObject()
Deprecated.
please use addObjectStructure().
|
void |
addObjectStructure()
Adds object structure to the list of existing os records
|
void |
breakData()
Parses channel/ service documnet data and sets corresponding object
variables.
|
void |
breakIntObject()
Deprecated.
please use breakMos().
|
void |
breakObjectStructure()
Parses object structure and sets global variables.
|
void |
clear()
clear Mbo cache
|
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.util.List |
getChildrenData()
Get child Elements as a list
|
MboRemote |
getCurrentMbo()
Return Main MBO which associated with current noun
|
StructureObject |
getCurrentObject()
Return Main MBO which associated with current noun
|
int |
getCurrentPosition()
gets current position
|
org.jdom.Document |
getData()
Return data in jdom Documnet format
|
byte[] |
getDataAsBytes()
Return the whole documnet as bytes.
|
java.lang.String |
getDataAsString() |
java.lang.String |
getDbBuild()
Deprecated.
please use getBuild()
|
java.util.List |
getHierarchyObjectList()
Get list of hierarrchy objects in mos in the Structure data
|
java.util.List |
getIntObjectList()
Deprecated.
plase use getPrimaryObjectList()
|
OslcRequest |
getJsonRequest()
Return OslcRequest (will be used for JSON only)
|
java.lang.String |
getLanguage()
Get base language of the Maximo.
|
java.lang.String |
getMajorVersion()
Deprecated.
please use getBuild()
|
java.util.ArrayList<MboRemote> |
getMboArray()
Return list of Main MBOs which associated with xml
|
MboRemote |
getMboFromMemory()
Return Mbo from memory
|
java.lang.String |
getMessageID()
Get Message ID of the Structure Data
|
java.lang.String |
getMinorVersion()
Deprecated.
please use getBuild()
|
byte[] |
getOriginalByteData()
Return the whole documnet 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)
|
MboRemote |
getRealMbo(java.lang.String objectName)
Return real Mbo for non-persistent top level Mbo
|
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 dta broken or not.
|
boolean |
isIR()
Deprecated.
use isBroken
|
boolean |
isMultiIntObject()
Deprecated.
please use isMultiMos()
|
boolean |
isMultiObjectStructure()
checks whether XML has multiple object structures
|
boolean |
isPatch()
Return is patch operation
|
void |
moveToFirstIntObject()
Deprecated.
please use moveToFirstObjectStruture().
|
void |
moveToFirstObjectStruture()
Reset Structure Data to point to first object structure.
|
boolean |
moveToNextIntObject()
Deprecated.
please use moveToNextObjectStructure().
|
boolean |
moveToNextObjectStructure()
moves to the next object structure .
|
boolean |
moveToPrevIntObject()
Deprecated.
please use moveToPrevObjectStructure().
|
boolean |
moveToPrevObjectStructure()
moves to the previous object structure.
|
void |
removeChildren()
Deprecated.
|
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 |
removeCurrentIntObject()
Deprecated.
please use removeCurrentObjectStruture().
|
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 |
setCurrentMbo(MboRemote mbo)
Set main MBO fro current integration object
|
void |
setCurrentPosition(int pos)
Sets current position
|
void |
setIsPatch(boolean isPatch)
Sets is patch
|
void |
setJsonRequest(OslcRequest jsonRequest)
Set OslcRequest (will be used for JSON only)
|
void |
setMboArray(java.util.ArrayList<MboRemote> in)
Set list of Main Mbos
|
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
|
void |
setRealMbo(MboRemote rm)
Sets real Mbo for non-persistent top level Mbo
|
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
|
createChildrenData, getAttr, getAttr, getChildrenData, getChildrenKeys, getCurrentAction, getCurrentData, getCurrentData, getCurrentDataAsBinaryText, getCurrentDataAsBoolean, getCurrentDataAsBytes, getCurrentDataAsDate, getCurrentDataAsDouble, getCurrentDataAsElement, getCurrentDataAsInt, getCurrentDataAsList, getCurrentDataAsLong, getCurrentDataAsString, getCurrentNamespacePrefix, getCurrentNamespaceURI, getGL, getGL, getGLComponent, getLocalRef, getName, getNamespaces, getOverrideType, getParentData, getParentData, getRowStamp, hasChildren, hasDetailData, isContentLocalized, isCurrentActionNull, isCurrentDataChanged, isCurrentDataNull, isCurrentDataObject, isEditMode, isGLDataNull, isGLDataNull, isHidden, isInCurrentData, isSaveEditMode, isSetValueMode, removeChildData, removeChildren, removeFromCurrentData, setCurrentAction, setCurrentData, setCurrentData, setCurrentData, setCurrentData, setCurrentData, setCurrentData, setCurrentDataNull, setCurrentNamespace, setEditMode, setGL, setGL, setGL, setNamespaces, setSaveEditMode, setSetValueMode, setXPathData
public StructureData()
public StructureData(java.lang.String operaton, java.lang.String osName, java.lang.String lang, int size, boolean isEvent, boolean isResponse) throws MXException, java.rmi.RemoteException
operaton
- The operation of the service/channelosName
- The sobject structure name.lang
- The language of transaction.size
- The object size.isEvent
- Determines if thats an event.isResponse
- Determines if thats a response.MXException,
- RemoteExceptionMXException
java.rmi.RemoteException
public StructureData(org.jdom.Document input) throws MXException
input
- the jdom documentMXException
public StructureData(byte[] data) throws MXException
data
- byte array for the MOS XMLMXException
public StructureData(java.lang.String data) throws MXException
data
- string for the MOS XMLMXException
public boolean isIR()
public boolean isBroken()
public void addIntObject() throws MXException
MXException
public void addObjectStructure() throws MXException
MXException
public boolean moveToNextIntObject() throws MXException
MXException
public boolean moveToNextObjectStructure() throws MXException
MXException
public boolean moveToPrevIntObject() throws MXException
MXException
public boolean moveToPrevObjectStructure() throws MXException
MXException
public void moveToFirstIntObject() throws MXException
MXException
public void moveToFirstObjectStruture() throws MXException
MXException
public void removeCurrentIntObject() throws MXException
MXException
public void removeCurrentObjectStructure() throws MXException
MXException
public void removeChildrenFromPrimaryObject() throws java.rmi.RemoteException, MXException
MXException
java.rmi.RemoteException
public void removeChildren() throws java.rmi.RemoteException, MXException
MXException
java.rmi.RemoteException
public org.jdom.Document getData()
public boolean hasDocument()
public byte[] getDataAsBytes()
public java.lang.String getDataAsString()
public byte[] getOriginalByteData()
public java.lang.Object clone()
clone
in class java.lang.Object
public void breakData() throws MXException
MXException
public void breakIntObject() throws MXException
MXException
public void breakObjectStructure() throws MXException
MXException
public StructureObject setMicData(org.jdom.Element data)
data
- Give reference Element to set to curent level.public void createChildrenData(java.lang.String name, boolean setAsCurrent)
name
- Name of the child level. This will move the current data
pointer to the child level.setAsCurrent
- boolean to identify setting chil as current lvel or notpublic boolean setParentAsCurrent()
public java.util.List getChildrenData()
getChildrenData
in class StructureObject
public java.util.List getIntObjectList()
public java.util.List getPrimaryObjectList()
public java.util.List getHierarchyObjectList()
public int getSize()
public boolean isMultiIntObject()
public boolean isMultiObjectStructure()
public java.lang.String getPrimaryObjectName()
public java.lang.String getLanguage() throws MXException
MXException
public java.lang.String getTransLanguage() throws MXException
MXException
public org.jdom.Element getPrimaryObject()
public java.lang.Object getPrimaryObjectAsObject() throws MXException
MXException
public StructureObject getStructureObject(int pos)
pos
- Position of the object strucure in the list.public java.lang.String getAction()
public boolean isActionNull()
public boolean isPatch() throws MXException
MXException
public void setIsPatch(boolean isPatch) throws MXException
isPatch
- is patch.MXException
public java.lang.String getMessageID()
public void removeCurrentData()
public void setPrimaryObject(org.jdom.Element h)
h
- Give reference Element to set to primary object.public void setPrimaryObject(java.lang.String name)
name
- name of the primary objectpublic void setCurrentPosition(int pos)
pos
- Position of the object strucure in the list.public int getCurrentPosition()
public java.lang.String getRootName()
public void setAction(java.lang.String action)
action
- action value to be set.public void setActionNull()
public void setChildrenData(java.util.List<org.jdom.Element> l)
l
- Give reference to List of Element to set as child.public StructureObject setAsCurrent(org.jdom.Element data)
data
- Give reference to Element to set as current.public StructureObject setAsCurrent(java.lang.Object data)
data
- Give reference to Element to set as current.public void setAsCurrent(java.util.List data, int i)
i
- the index.public StructureObject setAsCurrent()
public StructureObject setAsCurrent(java.lang.String xPathExpression) throws MXException
xPathExpression
- Give XPath expression.MXException
public StructureObject getStructureObject(java.lang.String xPathExpression) throws MXException
xPathExpression
- Give XPath expression.MXException
public java.lang.String getXPathData(java.lang.String xPathExpression) throws MXException
MXException
public java.util.List getStructureObjectList(java.lang.String xPathExpression) throws MXException
MXException
public void setMessageID(java.lang.String id)
public void setMboArray(java.util.ArrayList<MboRemote> in)
public void setCurrentMbo(MboRemote mbo)
public MboRemote getCurrentMbo() throws MXException
MXException
public java.util.ArrayList<MboRemote> getMboArray()
public MboRemote getRealMbo(java.lang.String objectName) throws MXException, java.rmi.RemoteException
MXException
java.rmi.RemoteException
public void setRealMbo(MboRemote rm)
rm
- Mbo for non-persistent top level Mbopublic StructureObject getCurrentObject()
getCurrentObject
in class StructureObject
public void clear()
public java.lang.String getBuild()
public java.lang.String getMajorVersion()
public java.lang.String getMinorVersion()
public java.lang.String getDbBuild()
public OslcRequest getJsonRequest()
public MboRemote getMboFromMemory() throws java.rmi.RemoteException, MXException
java.rmi.RemoteException
MXException
public void setJsonRequest(OslcRequest jsonRequest) throws MXException
jsonRequest
- OslcRequest objectMXException
public java.lang.String toString()
toString
in class StructureObject