SymbolTable (Java 3D Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.java3d.utils.scenegraph.io.retained.SymbolTable

All Implemented Interfaces:

SceneGraphObjectReferenceControl
```
public class SymbolTable
extends Object
implements SceneGraphObjectReferenceControl
```
SymbolTable class for SceneGraph I/O.

Constructor Summary

Constructors
Constructor and Description

SymbolTable(Controller control)
Creates new SymbolTable

Constructors
Constructor and Description
`SymbolTable(Controller control)` Creates new SymbolTable

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addBranchGraphReference(SceneGraphObject node, int branchGraphID)` Add a refernce to the BranchGraph root Also returns the nodes id Used to associate graphs with a locale without storing the graph at the current time.
`void`	`addNamedObject(String name, SceneGraphObject object)` Associate the name with the scene graph object
`void`	`addNamedObjects(HashMap map)` Add all the named objects in `map`
`int`	`addReference(SceneGraphObject node)` Add a refernce to the specified node Also returns the nodes id
`int`	`addReference(SymbolTableData symbol)` Add a refernce to the specified node Also returns the nodes id
`boolean`	`branchGraphHasDependencies(int graphID)` Return true if the graph is dependent on nodes in other graphs Only Nodes (not node components) cause dependencies
`void`	`clear()` Clear all elements from the symbol table
`void`	`clearUnshared()` Clear all the Symbols that are not shared with other Graphs in the file Remove all Symbols from all structures with referenceCounts=1
`SymbolTableData`	`createSymbol(SceneGraphObject node)` Create a new symbol and provide a new nodeID This is used during the save process
`SymbolTableData`	`createSymbol(SceneGraphObjectState state, SceneGraphObject node, int nodeID)` Create a new symbol using the specified nodeID This is used during the load process.
`void`	`endUnsavedNodeComponentFrame()`
`int`	`getBranchGraphCount()`
`int[]`	`getBranchGraphDependencies(int graphID)` Return an array of each BranchGraph on which graphID is dependent for closure of the graph Only Nodes (not node components) cause dependencies If there are no dependencies int[0] is returned
`long`	`getBranchGraphFilePosition(int graphID)`
`SymbolTableData`	`getBranchGraphRoot(int graphID)`
`SceneGraphObject`	`getJ3dNode(int nodeID)` Return the Java3D node associated with the nodeID.
`SceneGraphObject`	`getNamedObject(String name)` Return the SceneGraphObject associated with the name
`void`	`getNamedObjectMap(HashMap map)` Add the namedObject mappings to `map`
`String[]`	`getNames()` Get all the names of the named objects
`SymbolTableData`	`getSharedGroup(int nodeID)` Get the symbol for the shared group If the sharedgroup has not been loaded then load it before returning (if we are using RandomAccessFileControl
`SymbolTableData`	`getSymbol(int nodeID)` Return the node with the give ID
`SymbolTableData`	`getSymbol(SceneGraphObject node)` Get the table entry for node
`ListIterator`	`getUnsavedNodeComponents()`
`int`	`getUnsavedNodeComponentsSize()`
`void`	`incNodeComponentRefCount(int nodeID)` Update the reference count for the node component.
`boolean`	`isLoaded(int nodeID)` Return true if this node has already been loaded
`void`	`readTable(DataInput in, boolean streamRead)` Read and store the entire symbol table
`SceneGraphObject`	`resolveReference(int nodeID)` Given a nodeID return the corresponding scene graph object.
`void`	`setBranchGraphID(SymbolTableData symbol)` Set the branchGraphID in the symbol to the current branch graph ID
`void`	`setBranchGraphRoot(SymbolTableData symbol, long filePointer)` Mark the node referenced by this Symbol as a branch graph root The filePointer is the position of the BranchGraph in the file, this is not the same as the BranchGroups position due to the extra data stored for a graph.
`void`	`setFilePosition(long ptr, SceneGraphObjectState state)` Set the position of the object referenced by state
`void`	`startUnsavedNodeComponentFrame()`
`String`	`toString()`
`void`	`writeTable(DataOutput out)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SymbolTable
```
public SymbolTable(Controller control)
```
    Creates new SymbolTable
- Method Detail
  - writeTable
```
public void writeTable(DataOutput out)
                throws IOException
```
    Throws:
    
    IOException
  - readTable
```
public void readTable(DataInput in,
                      boolean streamRead)
               throws IOException
```
    Read and store the entire symbol table
    
    Parameters:
    
    streamRead - - true if reading from a Stream in which case only the branchGraphs and named objects are read.
    
    Throws:
    
    IOException
  - setBranchGraphRoot
```
public void setBranchGraphRoot(SymbolTableData symbol,
                               long filePointer)
```
    Mark the node referenced by this Symbol as a branch graph root The filePointer is the position of the BranchGraph in the file, this is not the same as the BranchGroups position due to the extra data stored for a graph.
  - getBranchGraphRoot
```
public SymbolTableData getBranchGraphRoot(int graphID)
```
  - setBranchGraphID
```
public void setBranchGraphID(SymbolTableData symbol)
```
    Set the branchGraphID in the symbol to the current branch graph ID
  - getBranchGraphDependencies
```
public int[] getBranchGraphDependencies(int graphID)
```
    Return an array of each BranchGraph on which graphID is dependent for closure of the graph Only Nodes (not node components) cause dependencies If there are no dependencies int[0] is returned
  - branchGraphHasDependencies
```
public boolean branchGraphHasDependencies(int graphID)
```
    Return true if the graph is dependent on nodes in other graphs Only Nodes (not node components) cause dependencies
  - getBranchGraphCount
```
public int getBranchGraphCount()
```
  - getBranchGraphFilePosition
```
public long getBranchGraphFilePosition(int graphID)
```
  - createSymbol
```
public SymbolTableData createSymbol(SceneGraphObject node)
```
    Create a new symbol and provide a new nodeID This is used during the save process
  - createSymbol
```
public SymbolTableData createSymbol(SceneGraphObjectState state,
                                    SceneGraphObject node,
                                    int nodeID)
```
    Create a new symbol using the specified nodeID This is used during the load process.
  - getUnsavedNodeComponentsSize
```
public int getUnsavedNodeComponentsSize()
```
  - getUnsavedNodeComponents
```
public ListIterator getUnsavedNodeComponents()
```
  - startUnsavedNodeComponentFrame
```
public void startUnsavedNodeComponentFrame()
```
  - endUnsavedNodeComponentFrame
```
public void endUnsavedNodeComponentFrame()
```
  - incNodeComponentRefCount
```
public void incNodeComponentRefCount(int nodeID)
```
    Update the reference count for the node component. Called during NodeComponentState.addSubReference()
  - addReference
```
public int addReference(SceneGraphObject node)
```
    Add a refernce to the specified node Also returns the nodes id
    
    Specified by:
    
    addReference in interface SceneGraphObjectReferenceControl
  - addReference
```
public int addReference(SymbolTableData symbol)
```
    Add a refernce to the specified node Also returns the nodes id
  - addBranchGraphReference
```
public int addBranchGraphReference(SceneGraphObject node,
                                   int branchGraphID)
```
    Add a refernce to the BranchGraph root Also returns the nodes id Used to associate graphs with a locale without storing the graph at the current time.
  - isLoaded
```
public boolean isLoaded(int nodeID)
```
    Return true if this node has already been loaded
  - getJ3dNode
```
public SceneGraphObject getJ3dNode(int nodeID)
```
    Return the Java3D node associated with the nodeID. The method will call buildGraph() on the node if necessary
  - getSymbol
```
public SymbolTableData getSymbol(SceneGraphObject node)
```
    Get the table entry for node
  - getSymbol
```
public SymbolTableData getSymbol(int nodeID)
```
    Return the node with the give ID
  - getSharedGroup
```
public SymbolTableData getSharedGroup(int nodeID)
```
    Get the symbol for the shared group If the sharedgroup has not been loaded then load it before returning (if we are using RandomAccessFileControl
  - setFilePosition
```
public void setFilePosition(long ptr,
                            SceneGraphObjectState state)
```
    Set the position of the object referenced by state
  - addNamedObject
```
public void addNamedObject(String name,
                           SceneGraphObject object)
```
    Associate the name with the scene graph object
  - addNamedObjects
```
public void addNamedObjects(HashMap map)
```
    Add all the named objects in map
  - getNamedObject
```
public SceneGraphObject getNamedObject(String name)
                                throws NamedObjectException,
                                       ObjectNotLoadedException
```
    Return the SceneGraphObject associated with the name
    
    Throws:
    
    NamedObjectException
    
    ObjectNotLoadedException
  - getNames
```
public String[] getNames()
```
    Get all the names of the named objects
  - getNamedObjectMap
```
public void getNamedObjectMap(HashMap map)
```
    Add the namedObject mappings to map
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clear
```
public void clear()
```
    Clear all elements from the symbol table
  - clearUnshared
```
public void clearUnshared()
```
    Clear all the Symbols that are not shared with other Graphs in the file Remove all Symbols from all structures with referenceCounts=1
  - resolveReference
```
public SceneGraphObject resolveReference(int nodeID)
```
    Given a nodeID return the corresponding scene graph object. Use only during the load cycle
    
    Specified by:
    
    resolveReference in interface SceneGraphObjectReferenceControl

Class SymbolTable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SymbolTable

Method Detail

writeTable

readTable

setBranchGraphRoot

getBranchGraphRoot

setBranchGraphID

getBranchGraphDependencies

branchGraphHasDependencies

getBranchGraphCount

getBranchGraphFilePosition

createSymbol

createSymbol

getUnsavedNodeComponentsSize

getUnsavedNodeComponents

startUnsavedNodeComponentFrame

endUnsavedNodeComponentFrame

incNodeComponentRefCount

addReference

addReference

addBranchGraphReference

isLoaded

getJ3dNode

getSymbol

getSymbol

getSharedGroup

setFilePosition

addNamedObject

addNamedObjects

getNamedObject

getNames

getNamedObjectMap

toString

clear

clearUnshared

resolveReference