public class MRvTreeImpl extends MRvNodeImpl implements MTreeImpl
MTree
class provides a tree-type structure for data representation.
Trees consist of nodes. Each node can be an MNode
or an MTree
.
Applications are responsible for converting data from source application format to
MTree
format and from MTree
format to target application format.
m_Data, m_EncapsulatedData
Constructor and Description |
---|
MRvTreeImpl(java.lang.String p_name)
Constructor for creating
MTree instances. |
MRvTreeImpl(java.lang.String p_name,
int format) |
MRvTreeImpl(java.lang.String p_name,
java.lang.Object p_data)
internal use only - do not document
|
MRvTreeImpl(com.tibco.tibrv.TibrvMsg p_msg,
boolean p_copy)
internal use only - do not document
|
Modifier and Type | Method and Description |
---|---|
void |
append(MNode p_node)
Add the given node to the list of children of this tree node.
|
void |
append(java.lang.String p_name,
boolean p_data)
Add the given node to the list of children of this tree node.
|
void |
append(java.lang.String p_name,
byte p_data)
Add the given node to the list of children of this tree node.
|
void |
append(java.lang.String p_name,
double p_data)
Add the given node to the list of children of this tree node.
|
void |
append(java.lang.String p_name,
float p_data)
Add the given node to the list of children of this tree node.
|
void |
append(java.lang.String p_name,
int p_data)
Add the given node to the list of children of this tree node.
|
void |
append(java.lang.String p_name,
long p_data)
Add the given node to the list of children of this tree node.
|
void |
append(java.lang.String p_name,
java.lang.Object p_value)
This form supports the following data types:
MNode , MTree , Short , Integer , Long ,
Float , Double , String , Byte , Boolean |
void |
append(java.lang.String p_name,
short p_data)
Add the given node to the list of children of this tree node.
|
void |
clear() |
boolean |
containsNode(java.lang.String p_name)
Return
true if there is a child node with the given name. |
void |
finalize() |
MGUID |
getAssignMsgGUID()
internal use only - do not document
|
int |
getFieldCount()
internal use only - do not document
|
java.lang.String |
getFieldName(int p_index)
internal use only - do not document
|
java.lang.Object |
getJmsProperty(java.lang.String p_propName)
internal use only - do not document
|
MNode |
getNode(java.lang.String p_name)
Return the first node encountered that has the specified name.
|
java.util.Enumeration |
getNodes()
Enumerate over the list of immediate child nodes.
|
MNode |
getProperty(java.lang.String p_propName)
internal use only - do not document
|
short |
getRepresentationEncoding()
internal use only - do not document
|
short |
getRepresentationFormat()
internal use only - do not document
|
short |
getRepresentationType()
internal use only - do not document
|
short |
getRepresentationVersion()
internal use only - do not document
|
java.lang.String |
getTextBody() |
MTrackingInfo |
getTrackingInfo()
Retrieve the tracking information from the
MTree object. |
java.lang.Object |
getUnderlyingMsg() |
java.lang.Object |
getValue(java.lang.String p_name)
Return the value of the node whose name is given.
|
boolean |
hasTrackingInfo()
internal use only - do not document
|
java.util.Enumeration |
newPropertyEnumerator()
internal use only - do not document
|
void |
setAssignMsgGUID(MGUID p_guid)
internal use only - do not document
|
void |
setProperty(java.lang.String propertyName,
boolean propertyValue) |
void |
setProperty(java.lang.String propertyName,
byte propertyValue) |
void |
setProperty(java.lang.String propertyName,
double propertyValue) |
void |
setProperty(java.lang.String propertyName,
float propertyValue) |
void |
setProperty(java.lang.String propertyName,
int propertyValue) |
void |
setProperty(java.lang.String propertyName,
long propertyValue) |
void |
setProperty(java.lang.String p_propName,
MNode p_node)
internal use - do not document
|
void |
setProperty(java.lang.String propertyName,
short propertyValue) |
void |
setProperty(java.lang.String sPropertyName,
java.lang.String sPropertyValue) |
void |
setRepresentationEncoding(short p_encoding)
internal use only - do not document
|
void |
setRepresentationFormat(short p_format)
internal use - do not document
|
void |
setRepresentationType(short p_type)
internal use - do not document
|
void |
setRepresentationVersion(short p_version)
internal use - do not document
|
void |
setTextBody(java.lang.String sFieldName) |
void |
setTrackingInfo(MTrackingInfo p_data)
Forward the tracking info to a new
MTree object. |
com.tibco.tibrv.TibrvMsg |
to_tibrvMsg()
internal use only - do not document
|
void |
use_tibamxMsg(AmxMessage inMsg) |
void |
use_tibrvMsg(com.tibco.tibrv.TibrvMsg msg)
internal use only - do not document
|
getData, getIdAsString, getName, toString
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
getData, getIdAsString, getName
public MRvTreeImpl(java.lang.String p_name)
MTree
instances. This constructor instantiates
a MTree
object with the specified name.p_name
- Required parameter specifying the name of the MTree
to create.public MRvTreeImpl(java.lang.String p_name, int format)
public MRvTreeImpl(java.lang.String p_name, java.lang.Object p_data)
public MRvTreeImpl(com.tibco.tibrv.TibrvMsg p_msg, boolean p_copy) throws MException
MException
public void append(MNode p_node) throws MException
MTree
, a subtree is added; the name of the
root of the subtree is the specified name
.MNode
, the node value is extracted and appended
with the name specified by name
.
MTree
field names may not contain special (non-alphanumeric) characters.
The null character is not valid in a field name.
append
in interface MTreeImpl
p_node
- Name of the node (or tree) to appendMException
- when the value passed in does not map to the data types
supported by com.tibco.tibrv.TibrvMsg
. See the TIBCO Rendezvous documentation for information.See the MTree.append() Example.
public void append(java.lang.String p_name, java.lang.Object p_value) throws MException
MNode
, MTree
, Short
, Integer
, Long
,
Float
, Double
, String
, Byte
, Boolean
MTree
field names may not contain special (non-alphanumeric) characters. The
null character is not valid in a field name.
append
in interface MTreeImpl
p_name
- Name of the node (or tree) to append.p_value
- Value to append.MException
append(MNode)
public void append(java.lang.String p_name, boolean p_data) throws MException
append
in interface MTreeImpl
p_name
- Name of the node (or tree) to append.p_data
- Data to append.MException
append(MNode)
public void append(java.lang.String p_name, byte p_data) throws MException
append
in interface MTreeImpl
p_name
- Name of the node (or tree) to append.p_data
- Data to append.MException
append(MNode)
public void append(java.lang.String p_name, short p_data) throws MException
append
in interface MTreeImpl
p_name
- Name of the node (or tree) to append.p_data
- Data to append.MException
append(MNode)
public void append(java.lang.String p_name, int p_data) throws MException
append
in interface MTreeImpl
p_name
- Name of the node (or tree) to append.p_data
- Data to append.MException
append(MNode)
public void append(java.lang.String p_name, long p_data) throws MException
append
in interface MTreeImpl
p_name
- Name of the node (or tree) to append.p_data
- Data to append.MException
append(MNode)
public void append(java.lang.String p_name, float p_data) throws MException
append
in interface MTreeImpl
p_name
- Name of the node (or tree) to append.p_data
- Data to append.MException
append(MNode)
public void append(java.lang.String p_name, double p_data) throws MException
append
in interface MTreeImpl
p_name
- Name of the node (or tree) to append.p_data
- Data to append.MException
append(MNode)
public MNode getNode(java.lang.String p_name)
public java.lang.Object getValue(java.lang.String p_name)
getNode(nodeName)
.public java.util.Enumeration getNodes()
Enumeration.nextElement()
returns an MNode
. The object returned by the enumeration
can be cast to MNode
or MTree
.public boolean containsNode(java.lang.String p_name)
true
if there is a child node with the given name.containsNode
in interface MTreeImpl
p_name
- Name of the node you are looking for.public void setTrackingInfo(MTrackingInfo p_data)
MTree
object.
MTrackingInfo.addApplicationInfo()
must
be called before tracking data is set.
setTrackingInfo
in interface MTreeImpl
p_data
- The information to forward.getTrackingInfo()
public MTrackingInfo getTrackingInfo()
MTree
object.
If there isnt any tracking data available, create a new tracking data with "source undefined" as tracking information.
getTrackingInfo
in interface MTreeImpl
setTrackingInfo(MTrackingInfo)
public void setRepresentationEncoding(short p_encoding)
setRepresentationEncoding
in interface MTreeImpl
public short getRepresentationEncoding()
getRepresentationEncoding
in interface MTreeImpl
public void setRepresentationType(short p_type)
Possible values for rep. type are 1 for RVMsg & 10 for XML
setRepresentationType
in interface MTreeImpl
public short getRepresentationType()
getRepresentationType
in interface MTreeImpl
public void setRepresentationFormat(short p_format)
setRepresentationFormat
in interface MTreeImpl
public short getRepresentationFormat()
getRepresentationFormat
in interface MTreeImpl
public void setRepresentationVersion(short p_version)
Possible values for rep. type are 1 for RVMsg & 10 for XML 10 = Wireformat version2.0 30 = Wireformat version 3.0
setRepresentationVersion
in interface MTreeImpl
public short getRepresentationVersion()
getRepresentationVersion
in interface MTreeImpl
public void setProperty(java.lang.String p_propName, MNode p_node)
setProperty
in interface MTreeImpl
public MNode getProperty(java.lang.String p_propName)
getProperty
in interface MTreeImpl
public java.lang.Object getJmsProperty(java.lang.String p_propName)
getJmsProperty
in interface MTreeImpl
public java.util.Enumeration newPropertyEnumerator()
newPropertyEnumerator
in interface MTreeImpl
public void finalize() throws java.lang.Throwable
public boolean hasTrackingInfo()
hasTrackingInfo
in interface MTreeImpl
public com.tibco.tibrv.TibrvMsg to_tibrvMsg()
to_tibrvMsg
in interface MTreeImpl
public java.lang.Object getUnderlyingMsg()
getUnderlyingMsg
in interface MTreeImpl
public void setAssignMsgGUID(MGUID p_guid)
setAssignMsgGUID
in interface MTreeImpl
public MGUID getAssignMsgGUID()
getAssignMsgGUID
in interface MTreeImpl
public int getFieldCount()
getFieldCount
in interface MTreeImpl
public java.lang.String getFieldName(int p_index)
getFieldName
in interface MTreeImpl
public void use_tibrvMsg(com.tibco.tibrv.TibrvMsg msg)
use_tibrvMsg
in interface MTreeImpl
public void setTextBody(java.lang.String sFieldName) throws MException
setTextBody
in interface MTreeImpl
MException
public java.lang.String getTextBody() throws MException
getTextBody
in interface MTreeImpl
MException
public void setProperty(java.lang.String propertyName, boolean propertyValue)
setProperty
in interface MTreeImpl
public void setProperty(java.lang.String propertyName, byte propertyValue)
setProperty
in interface MTreeImpl
public void setProperty(java.lang.String propertyName, double propertyValue)
setProperty
in interface MTreeImpl
public void setProperty(java.lang.String propertyName, float propertyValue)
setProperty
in interface MTreeImpl
public void setProperty(java.lang.String propertyName, int propertyValue)
setProperty
in interface MTreeImpl
public void setProperty(java.lang.String propertyName, long propertyValue)
setProperty
in interface MTreeImpl
public void setProperty(java.lang.String propertyName, short propertyValue)
setProperty
in interface MTreeImpl
public void setProperty(java.lang.String sPropertyName, java.lang.String sPropertyValue)
setProperty
in interface MTreeImpl
public void use_tibamxMsg(AmxMessage inMsg)
use_tibamxMsg
in interface MTreeImpl