MDSplus

Class TreeNode

java.lang.Object

MDSplus.Data

MDSplus.TreeNode

Direct Known Subclasses:

TreePath

public class TreeNode
extends Data

Class TreeNode holds all the node-specific information.

Version:

1.0

Author:

manduchi

Field Summary

Fields

Modifier and Type	Field and Description
protected int	nid

Fields inherited from class MDSplus.Data

CLASS_A, CLASS_APD, CLASS_D, CLASS_R, CLASS_S, DTYPE_ACTION, DTYPE_B, DTYPE_BU, DTYPE_CALL, DTYPE_CONDITION, DTYPE_CONGLOM, DTYPE_DEPENDENCY, DTYPE_DICTIONARY, DTYPE_DIMENSION, DTYPE_DISPATCH, DTYPE_DOUBLE, DTYPE_DSC, DTYPE_EVENT, DTYPE_FLOAT, DTYPE_FUNCTION, DTYPE_IDENT, DTYPE_L, DTYPE_LIST, DTYPE_LU, DTYPE_METHOD, DTYPE_NID, DTYPE_O, DTYPE_OU, DTYPE_PARAM, DTYPE_PATH, DTYPE_PROCEDURE, DTYPE_PROGRAM, DTYPE_Q, DTYPE_QU, DTYPE_RANGE, DTYPE_ROUTINE, DTYPE_SIGNAL, DTYPE_SLOPE, DTYPE_T, DTYPE_TUPLE, DTYPE_W, DTYPE_WINDOW, DTYPE_WITH_ERROR, DTYPE_WITH_UNITS, DTYPE_WU, TreeDEPENDENCY_AND, TreeDEPENDENCY_OR, TreeIGNORE_STATUS, TreeIGNORE_UNDEFINED, TreeNEGATE_CONDITION

Constructor Summary

Constructors

Constructor and Description
TreeNode(Data help, Data units, Data error, Data validation)
TreeNode(int nid)
TreeNode(int nid, Data help, Data units, Data error, Data validation)
TreeNode(int nid, Tree tree)
TreeNode(int nid, Tree tree, Data help, Data units, Data error, Data validation)

Method Summary

Modifier and Type	Method and Description
TreeNode	addDevice(String name, String type) Add a devive intance to the tree open for edit.
TreeNode	addNode(String name, String usage) Add a node to the tree open for edit.
void	addTag(String tagName) Add a tag to this node in the tree open for edit.
void	beginSegment(Data start, Data end, Data dim, Array initData) Begin a new data segment
void	beginTimestampedSegment(Array initData) Begin a timestamted segment
void	clearNciFlag(int flagId)
boolean	containsVersions() Return true if the node contains versions
void	deleteData() Delete data associaed with this node
int	doAction()
void	doMethod(String method) Do specified method for this node (valid only if it belongs to a conglomerae)
String[]	findTags() Get the (list of) tags for this node
TreeNode	getBrother() Return next sibling.
TreeNode	getChild() Get the first child of this node
TreeNodeArray	getChildren() Get all che child nodes for this node
int	getCompressedLength() Return the size in bytes of (possibly compressed) associated data
int	getConglomerateElt() Get index of the node in the corresponding conglomerate
TreeNodeArray	getConglomerateNodes() Return the array of nodes corresponding to the elements of the conglomeate to which the node belongs
Data	getData() Get Data for this node
static TreeNode	getData(int nid)
static TreeNode	getData(int nid, Data help, Data units, Data error, Data validation)
String	getDclass() return data class as a java.lang.String
int	getDepth() Return the depth of the node in the tree
TreeNodeArray	getDescendants() Get all the descendant (members + children)for this node
String	getDtype() return data type as a java.lang.String
Data	getExtendedAttribute(String name) Get Extended Attribute
int	getFlags() Return the flag word
String	getFullPath() Get the full node pathname
int	getLength() Return the length in bytes of the contained data
TreeNode	getMember() Get the first member of this node
TreeNodeArray	getMembers() Return all the members of this node
String	getMinPath() Get the minimum path name for this node
boolean	getNciFlag(int flagId)
int	getNciFlags()
int	getNid() Get Node Identifier
String	getNodeName() Get the name of this node (not its path)
int	getNumChildren() Get the number of children for this node
int	getNumDescendants() Get the number of all descendants (members + children)fir this node
int	getNumElts() Return the number of the elements for the conglomerate to which the node belongs
int	getNumMembers() Get the number of members for this node
int	getNumSegments() Get the num,ber of segments
String	getOriginalPartName() Return the original path within the conglomerate to thich the node belongs
int	getOwnerId() Return the Group/Id of the last writer for that node
TreeNode	getParent() Get the parent of this node
String	getPath() Get the path name for this node
Array	getSegment(int idx) Get data form the selectede segment
Data	getSegmentDim(int idx)
Data	getSegmentEnd(int idx) Get end time for that segment
Data	getSegmentStart(int idx) Get start time fopr that segment
int	getStatus() Return the status of the completed action (if the node contains ActionData)
long	getTimeInserted() Get the time of the last data insertion
Tree	getTree() Get the associated tree instance
String	getUsage() Get the node usage as a string
boolean	isChild() Return true is the node is a child node
boolean	isCompressible() Return true if node is compressible.
boolean	isCompressOnPut() Return true if data has to be comressed when written.
boolean	isCompressSegments() Return true if segmented node is compressible.
boolean	isEssential() Return true id the node is essential (action necessary in dispatching)
boolean	isIncludedInPulse() Return true if the underlying subtree is included in the pulse file
boolean	isIncludeInPulse()
boolean	isMember() Return true id the node is a member node
boolean	isNoWriteModel() Return true if this node cannot be written in the model
boolean	isNoWriteShot() Return true if this node cannot be written in pulse files
boolean	isOn() Return true if the node is On
boolean	isParentOff() Return true if node parent is off
boolean	isSegmented() Return true if the node contains segmented data
boolean	isSetup() Return true if this is setup data (i.e.
boolean	isWriteOnce() Return true if it is only allowed to write once on this node
void	makeSegment(Data start, Data end, Data dim, Array initData)
void	makeTimestampedSegment(Data data, long[] times)
void	move(TreeNode parent)
void	move(TreeNode parent, String newName)
void	putData(byte d)
void	putData(byte[] d)
void	putData(Data data) Write data for this node
void	putData(double d)
void	putData(double[] d)
void	putData(float d)
void	putData(float[] d)
void	putData(int d)
void	putData(int[] d)
void	putData(long d)
void	putData(long[] d)
void	putData(short d)
void	putData(short[] d)
void	putData(String d)
void	putData(String[] d)
void	putRow(Data row, long time)
void	putRow(Data row, long time, int size) Writre a single row of timestamped data
void	putSegment(Array data, int offset) Write (part of) data segment
void	putTimestampedSegment(Data data, long[] times) Write (part of)data in a timestamped segment
void	remove(String name) Removes a node and its descendands from the tree open for edit.
void	removeTag(String tagName) Remove a tag to this node in the tree open for edit.
void	rename(String newName) Rename a node in edit.
protected void	resolveNid()
void	setCompressible(boolean flag) Node is compressible
void	setCompressOnPut(boolean flag) Node is compressible
void	setCompressSegments(boolean flag) Segmented Node is compressible
void	setEssential(boolean flag) Set essential flag
void	setExtendedAttribute(String name, Data val) Set Extended Attribute
void	setIncludedInPulse(boolean flag) Set includeInPulse flag
void	setIncludeInPulse(boolean flag)
void	setNciFlag(int flagId)
void	setNciFlags(int flags)
void	setNoWriteModel(boolean noWriteModel) Set NoWriteModel flag
void	setNoWriteShot(boolean noWriteShot)
void	setOn(boolean on) Set on/off for that node
void	setSubtree(boolean isSubtree) Derclare this node to be a reference to a (separate) subtree in the tree open for edit.
void	setTree(Tree tree) set the associated Tree instance
void	setWriteOnce(boolean writeOnce) Set WriteOnce flag
void	updateSegment(int segmentOffset, Data start, Data end, Data dim) Update start, end time and dimension for the specified segment

Methods inherited from class MDSplus.Data

compile, compile, convertToDate, data, deserialize, evaluate, execute, executeWithContext, getByte, getByteArray, getDimensionAt, getDouble, getDoubleArray, getError, getFloat, getFloatArray, getHelp, getInt, getIntArray, getLong, getLongArray, getMdsMsg, getShape, getShort, getShortArray, getSize, getSizeInBytes, getString, getStringArray, getTime, getUnits, getValidation, plot, serialize, setCtxTree, setError, setHelp, setUnits, setValidation, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toData, toDouble, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

nid

protected int nid

Constructor Detail

TreeNode

public TreeNode(int nid,
                Data help,
                Data units,
                Data error,
                Data validation)
         throws MdsException

Throws:

MdsException

TreeNode

public TreeNode(Data help,
                Data units,
                Data error,
                Data validation)
         throws MdsException

Throws:

MdsException

TreeNode

public TreeNode(int nid,
                Tree tree,
                Data help,
                Data units,
                Data error,
                Data validation)

TreeNode

public TreeNode(int nid,
                Tree tree)
         throws MdsException

Throws:

MdsException

TreeNode

public TreeNode(int nid)
         throws MdsException

Throws:

MdsException

Method Detail

getData

public static TreeNode getData(int nid)
                        throws MdsException

Throws:

MdsException

getData

public static TreeNode getData(int nid,
                               Data help,
                               Data units,
                               Data error,
                               Data validation)
                        throws MdsException

Throws:

MdsException

resolveNid

protected void resolveNid()
                   throws MdsException

Throws:

MdsException

isCompressOnPut

public boolean isCompressOnPut()
                        throws MdsException

Return true if data has to be comressed when written.

Throws:

MdsException

isCompressible

public boolean isCompressible()
                       throws MdsException

Return true if node is compressible.

Throws:

MdsException

isCompressSegments

public boolean isCompressSegments()
                           throws MdsException

Return true if segmented node is compressible.

Throws:

MdsException

setCompressible

public void setCompressible(boolean flag)
                     throws MdsException

Node is compressible

Parameters:

flag -

Throws:

MdsException

setCompressOnPut

public void setCompressOnPut(boolean flag)
                      throws MdsException

Node is compressible

Parameters:

flag -

Throws:

MdsException

setCompressSegments

public void setCompressSegments(boolean flag)
                         throws MdsException

Segmented Node is compressible

Parameters:

flag -

Throws:

MdsException

getConglomerateElt

public int getConglomerateElt()
                       throws MdsException

Get index of the node in the corresponding conglomerate

Throws:

MdsException

getNumElts

public int getNumElts()
               throws MdsException

Return the number of the elements for the conglomerate to which the node belongs

Throws:

MdsException

getFlags

public int getFlags()
             throws MdsException

Return the flag word

Throws:

MdsException

getConglomerateNodes

public TreeNodeArray getConglomerateNodes()
                                   throws MdsException

Return the array of nodes corresponding to the elements of the conglomeate to which the node belongs

Throws:

MdsException

getOriginalPartName

public String getOriginalPartName()
                           throws MdsException

Return the original path within the conglomerate to thich the node belongs

Throws:

MdsException

getDtype

public String getDtype()
                throws MdsException

return data type as a java.lang.String

Throws:

MdsException

getDclass

public String getDclass()
                 throws MdsException

return data class as a java.lang.String

Throws:

MdsException

isEssential

public boolean isEssential()
                    throws MdsException

Return true id the node is essential (action necessary in dispatching)

Throws:

MdsException

setEssential

public void setEssential(boolean flag)
                  throws MdsException

Set essential flag

Parameters:

flag -

Throws:

MdsException

getFullPath

public String getFullPath()
                   throws MdsException

Get the full node pathname

Throws:

MdsException

getMinPath

public String getMinPath()
                  throws MdsException

Get the minimum path name for this node

Throws:

MdsException

getPath

public String getPath()
               throws MdsException

Get the path name for this node

Throws:

MdsException

getNodeName

public String getNodeName()
                   throws MdsException

Get the name of this node (not its path)

Throws:

MdsException

isIncludedInPulse

public boolean isIncludedInPulse()
                          throws MdsException

Return true if the underlying subtree is included in the pulse file

Throws:

MdsException

isIncludeInPulse

public boolean isIncludeInPulse()
                         throws MdsException

Throws:

MdsException

setIncludedInPulse

public void setIncludedInPulse(boolean flag)
                        throws MdsException

Set includeInPulse flag

Parameters:

flag -

Throws:

MdsException

setIncludeInPulse

public void setIncludeInPulse(boolean flag)
                       throws MdsException

Throws:

MdsException

getDepth

public int getDepth()
             throws MdsException

Return the depth of the node in the tree

Throws:

MdsException

isChild

public boolean isChild()
                throws MdsException

Return true is the node is a child node

Throws:

MdsException

getChild

public TreeNode getChild()
                  throws MdsException

Get the first child of this node

Throws:

MdsException

getNumChildren

public int getNumChildren()
                   throws MdsException

Get the number of children for this node

Throws:

MdsException

getChildren

public TreeNodeArray getChildren()
                          throws MdsException

Get all che child nodes for this node

Throws:

MdsException

isMember

public boolean isMember()
                 throws MdsException

Return true id the node is a member node

Throws:

MdsException

getMember

public TreeNode getMember()
                   throws MdsException

Get the first member of this node

Throws:

MdsException

getNumMembers

public int getNumMembers()
                  throws MdsException

Get the number of members for this node

Throws:

MdsException

getMembers

public TreeNodeArray getMembers()
                         throws MdsException

Return all the members of this node

Throws:

MdsException

getNumDescendants

public int getNumDescendants()
                      throws MdsException

Get the number of all descendants (members + children)fir this node

Throws:

MdsException

getDescendants

public TreeNodeArray getDescendants()
                             throws MdsException

Get all the descendant (members + children)for this node

Throws:

MdsException

getParent

public TreeNode getParent()
                   throws MdsException

Get the parent of this node

Throws:

MdsException

getBrother

public TreeNode getBrother()
                    throws MdsException

Return next sibling.

Throws:

MdsException

getLength

public int getLength()
              throws MdsException

Return the length in bytes of the contained data

Throws:

MdsException

getCompressedLength

public int getCompressedLength()
                        throws MdsException

Return the size in bytes of (possibly compressed) associated data

Throws:

MdsException

getNid

public int getNid()
           throws MdsException

Get Node Identifier

Throws:

MdsException

isNoWriteModel

public boolean isNoWriteModel()
                       throws MdsException

Return true if this node cannot be written in the model

Throws:

MdsException

setNoWriteModel

public void setNoWriteModel(boolean noWriteModel)
                     throws MdsException

Set NoWriteModel flag

Parameters:

noWriteModel -

Throws:

MdsException

isNoWriteShot

public boolean isNoWriteShot()
                      throws MdsException

Return true if this node cannot be written in pulse files

Throws:

MdsException

setNoWriteShot

public void setNoWriteShot(boolean noWriteShot)
                    throws MdsException

Parameters:

noWriteShot -

Throws:

MdsException

isWriteOnce

public boolean isWriteOnce()
                    throws MdsException

Return true if it is only allowed to write once on this node

Throws:

MdsException

setWriteOnce

public void setWriteOnce(boolean writeOnce)
                  throws MdsException

Set WriteOnce flag

Parameters:

writeOnce -

Throws:

MdsException

getNciFlags

public int getNciFlags()
                throws MdsException

Throws:

MdsException

setNciFlags

public void setNciFlags(int flags)
                 throws MdsException

Throws:

MdsException

getNciFlag

public boolean getNciFlag(int flagId)
                   throws MdsException

Throws:

MdsException

setNciFlag

public void setNciFlag(int flagId)
                throws MdsException

Throws:

MdsException

clearNciFlag

public void clearNciFlag(int flagId)
                  throws MdsException

Throws:

MdsException

isOn

public boolean isOn()
             throws MdsException

Return true if the node is On

Throws:

MdsException

isParentOff

public boolean isParentOff()
                    throws MdsException

Return true if node parent is off

Throws:

MdsException

setExtendedAttribute

public void setExtendedAttribute(String name,
                                 Data val)
                          throws MdsException

Set Extended Attribute

Throws:

MdsException

getExtendedAttribute

public Data getExtendedAttribute(String name)
                          throws MdsException

Get Extended Attribute

Throws:

MdsException

setOn

public void setOn(boolean on)
           throws MdsException

Set on/off for that node

Parameters:

on -

Throws:

MdsException

getOwnerId

public int getOwnerId()
               throws MdsException

Return the Group/Id of the last writer for that node

Throws:

MdsException

getData

public Data getData()
             throws MdsException

Get Data for this node

Throws:

MdsException

putData

public void putData(Data data)
             throws MdsException

Write data for this node

Parameters:

data -

Throws:

MdsException

deleteData

public void deleteData()
                throws MdsException

Delete data associaed with this node

Throws:

MdsException

getTimeInserted

public long getTimeInserted()
                     throws MdsException

Get the time of the last data insertion

Throws:

MdsException

doMethod

public void doMethod(String method)
              throws MdsException

Do specified method for this node (valid only if it belongs to a conglomerae)

Parameters:

method -

Throws:

MdsException

isSetup

public boolean isSetup()
                throws MdsException

Return true if this is setup data (i.e. present in the the model)

Throws:

MdsException

getStatus

public int getStatus()
              throws MdsException

Return the status of the completed action (if the node contains ActionData)

Throws:

MdsException

getUsage

public String getUsage()
                throws MdsException

Get the node usage as a string

Throws:

MdsException

findTags

public String[] findTags()
                  throws MdsException

Get the (list of) tags for this node

Throws:

MdsException

containsVersions

public boolean containsVersions()
                         throws MdsException

Return true if the node contains versions

Throws:

MdsException

isSegmented

public boolean isSegmented()
                    throws MdsException

Return true if the node contains segmented data

Throws:

MdsException

beginSegment

public void beginSegment(Data start,
                         Data end,
                         Data dim,
                         Array initData)
                  throws MdsException

Begin a new data segment

Parameters:

start -

end -

dim -

initData -

Throws:

MdsException

makeSegment

public void makeSegment(Data start,
                        Data end,
                        Data dim,
                        Array initData)
                 throws MdsException

Throws:

MdsException

putSegment

public void putSegment(Array data,
                       int offset)
                throws MdsException

Write (part of) data segment

Parameters:

data -

offset -

Throws:

MdsException

updateSegment

public void updateSegment(int segmentOffset,
                          Data start,
                          Data end,
                          Data dim)
                   throws MdsException

Update start, end time and dimension for the specified segment

Parameters:

segmentOffset - (-1 fpr last segment)

start -

end -

dim -

Throws:

MdsException

beginTimestampedSegment

public void beginTimestampedSegment(Array initData)
                             throws MdsException

Begin a timestamted segment

Parameters:

initData -

Throws:

MdsException

putTimestampedSegment

public void putTimestampedSegment(Data data,
                                  long[] times)
                           throws MdsException

Write (part of)data in a timestamped segment

Parameters:

data -

times -

Throws:

MdsException

makeTimestampedSegment

public void makeTimestampedSegment(Data data,
                                   long[] times)
                            throws MdsException

Throws:

MdsException

putRow

public void putRow(Data row,
                   long time,
                   int size)
            throws MdsException

Writre a single row of timestamped data

Parameters:

row -

time -

Throws:

MdsException

putRow

public void putRow(Data row,
                   long time)
            throws MdsException

Throws:

MdsException

getNumSegments

public int getNumSegments()
                   throws MdsException

Get the num,ber of segments

Throws:

MdsException

getSegmentStart

public Data getSegmentStart(int idx)
                     throws MdsException

Get start time fopr that segment

Parameters:

idx -

Throws:

MdsException

getSegmentEnd

public Data getSegmentEnd(int idx)
                   throws MdsException

Get end time for that segment

Parameters:

idx -

Throws:

MdsException

getSegmentDim

public Data getSegmentDim(int idx)
                   throws MdsException

Parameters:

idx -

Throws:

MdsException

getSegment

public Array getSegment(int idx)
                 throws MdsException

Get data form the selectede segment

Parameters:

idx -

Throws:

MdsException

getTree

public Tree getTree()

Get the associated tree instance

setTree

public void setTree(Tree tree)

set the associated Tree instance

Parameters:

tree -

addNode

public TreeNode addNode(String name,
                        String usage)
                 throws MdsException

Add a node to the tree open for edit. The name is relative to this node instance.

Parameters:

name -

usage -

Throws:

MdsException

remove

public void remove(String name)
            throws MdsException

Removes a node and its descendands from the tree open for edit. The name is relative to this node instance.

Parameters:

name -

Throws:

MdsException

rename

public void rename(String newName)
            throws MdsException

Rename a node in edit.

Parameters:

oldName -

newName -

Throws:

MdsException

move

public void move(TreeNode parent,
                 String newName)
          throws MdsException

Throws:

MdsException

move

public void move(TreeNode parent)
          throws MdsException

Throws:

MdsException

addTag

public void addTag(String tagName)
            throws MdsException

Add a tag to this node in the tree open for edit.

Parameters:

tagName -

Throws:

MdsException

removeTag

public void removeTag(String tagName)
               throws MdsException

Remove a tag to this node in the tree open for edit.

Parameters:

tagName -

Throws:

MdsException

addDevice

public TreeNode addDevice(String name,
                          String type)
                   throws MdsException

Add a devive intance to the tree open for edit. The name is relative to this node instance.

Parameters:

name -

usage -

Throws:

MdsException

setSubtree

public void setSubtree(boolean isSubtree)
                throws MdsException

Derclare this node to be a reference to a (separate) subtree in the tree open for edit.

Parameters:

isSubtree -

Throws:

MdsException

doAction

public int doAction()
             throws MdsException

Throws:

MdsException

putData

public void putData(byte d)
             throws MdsException

Throws:

MdsException

putData

public void putData(short d)
             throws MdsException

Throws:

MdsException

putData

public void putData(int d)
             throws MdsException

Throws:

MdsException

putData

public void putData(long d)
             throws MdsException

Throws:

MdsException

putData

public void putData(float d)
             throws MdsException

Throws:

MdsException

putData

public void putData(double d)
             throws MdsException

Throws:

MdsException

putData

public void putData(String d)
             throws MdsException

Throws:

MdsException

putData

public void putData(byte[] d)
             throws MdsException

Throws:

MdsException

putData

public void putData(short[] d)
             throws MdsException

Throws:

MdsException

putData

public void putData(int[] d)
             throws MdsException

Throws:

MdsException

putData

public void putData(long[] d)
             throws MdsException

Throws:

MdsException

putData

public void putData(float[] d)
             throws MdsException

Throws:

MdsException

putData

public void putData(double[] d)
             throws MdsException

Throws:

MdsException

putData

public void putData(String[] d)
             throws MdsException

Throws:

MdsException