Package org.web3d.vrml.export

Class X3DRetainedSAXExporter

java.lang.Object

org.web3d.vrml.export.Exporter

org.web3d.vrml.export.BaseRetainedExporter

org.web3d.vrml.export.X3DRetainedSAXExporter

All Implemented Interfaces:

SceneGraphTraversalSimpleObserver, BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

Direct Known Subclasses:

X3DBinaryRetainedDirectExporter, X3DXMLRetainedExporter

public abstract class X3DRetainedSAXExporter
extends BaseRetainedExporter
implements SceneGraphTraversalSimpleObserver

A retained exporter that issues SAX events. Extensions of this class are expected to setup the content handler. This class should contain as much of the XML specific knowledge as possible. This implementation will use FastInfoSet's AttributesHolder to gain a type aware wrapper for attributes. Known Issues: Proto node fields are copied into instances

Version:

$Revision: 1.11 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	binary	Are we exporting to binary
protected static final int	BYTE_ALGORITHM_ID
protected boolean	compress	Should we strip all unnecessary characters
protected boolean	compressedAttWay	Switch between methods, should go away
protected int	compressionMethod	The compression method to use for binary
protected NodeCompressor	currentCompressor	The current compressor.
protected static final int	DELTA_ZLIB_INT_ARRAY_ALGORITHM_ID
protected Map	EMPTY_MAP	An empty map to avoid null testing
protected Writer	filterWriter	The passed in writer
protected ContentHandler	handler	The contentHandler to write to
protected boolean	ignoreData	Should we ignore data, its handled by the compressor
protected int	indent	The current indent level
protected static String	INDENT_STRING	The indent String to replicate per level
protected org.j3d.util.IntHashMap<String>	indentMap	A mapping of indent to String
protected String	indentString	The current indent string
static final int	METHOD_FASTEST_PARSING
static final int	METHOD_SMALLEST_LOSSY
static final int	METHOD_SMALLEST_NONLOSSY
static final int	METHOD_STRINGS
protected boolean	printDocType	Should we print the DOCTYPE
protected boolean	printXML	Should we print the XML Element
protected Set<PrototypeDecl>	protoDeclSet	The current set of proto definitions
protected Map<String,VRMLFieldDeclaration>	protoMap	Single level proto map
protected float	quantizeParam	The float lossy param
protected VRMLWorldRootNodeType	root	The world root
protected SceneGraphTraverser	traverser	Traverser for printing proto's
protected Set<VRMLNodeType>	usedNodes	Temporary map during traversal for use references
protected boolean	useNC	Should we use node compressors
protected Map<String,String>	x3dAtts	Extra attributes on the X3D tag

Fields inherited from class org.web3d.vrml.export.BaseRetainedExporter

builder, componentList, CONTAINER_PROPS_FILE, containerFields, convertOldContent, currentConnection, currentDefMap, currentIsMap, currentPrototypeDecl, defaultNode, defaultNodes, encodingTo, epToUrl, fieldReader, fieldRemap, geospatialFound, geospatialNodes, hanimFound, hanimNodes, isCache, nodeFactory, oldProtos, oStream, p, processingDocument, profile, protoCreator, scene, scriptPatterns, scriptReplacements, sigDigits, startTime, stripWhitespace, upgrading

Fields inherited from class org.web3d.vrml.export.Exporter

errorReporter, lastErrorCode, majorVersion, minorVersion

Constructor Summary

Constructors

Constructor	Description
X3DRetainedSAXExporter(int major, int minor, org.j3d.util.ErrorReporter errorReporter, int compressionMethod, float quantizeParam)	Create a new exporter for the given spec version
X3DRetainedSAXExporter(int major, int minor, org.j3d.util.ErrorReporter errorReporter, int compressionMethod, float quantizeParam, int sigDigits)	Create a new exporter for the given spec version

Method Summary

Modifier and Type	Method	Description
protected String	createX3DString(VRMLFieldDeclaration decl, double[] val, int numElements)	Create an X3D string from an array of values
protected String	createX3DString(VRMLFieldDeclaration decl, float[] val, int numElements)	Create an X3D string from an array of values
protected String	createX3DString(VRMLFieldDeclaration decl, int[] val, int numElements)	Create an X3D string from an array of values
protected void	encodeDoubleArray(double[] fval, int numElements, VRMLFieldDeclaration decl, String qName, com.sun.xml.fastinfoset.sax.AttributesHolder aholder, int ftype)	Encode double array data.
protected void	encodeFloatArray(float[] fval, int numElements, VRMLFieldDeclaration decl, String qName, com.sun.xml.fastinfoset.sax.AttributesHolder aholder, int ftype)	Encode float array data.
void	endDocument()	Declaration of the end of the document.
boolean	getPrintDocType()	Return the flag indicating that the doc type element is to be included
boolean	getPrintXML()	Return the flag indicating that the xml element is to be included
void	observedNode(VRMLNodeType parent, VRMLNodeType child, int field, boolean used)	Notification of a child node.
void	printComponents(ComponentInfo[] comps)	Print the component decl
void	printEndNode(VRMLNodeType node, boolean hadChildren, boolean compressed, Map<Integer,List<ProtoFieldInfo>> isMap)	Print the end of a node.
void	printExporterInfo()	Print identifying information about this exporter
void	printExports(Map<String,String> exports)	Print Exports.
void	printExternalPrototypeDecl(CRExternPrototypeDecl proto)	Print an external proto declaration.
void	printHeader(int major, int minor)	Print the header.
void	printImports(Map<String,VRMLNode> imports)	Print Imports.
void	printMetaData(Map<String,String> meta)	Print the MetaData.
void	printProfile(String profile)	Print the profile decl.
void	printPrototypeDecl(PrototypeDecl proto)	Print a proto declaration.
void	printROUTE(ROUTE route, Map<VRMLNode,String> defMap)	Print a ROUTE statement.
boolean	printStartNode(VRMLNodeType node, boolean use, Map<VRMLNode,String> defMap, Map<Integer,List<ProtoFieldInfo>> isMap, String containerField, boolean compressed)	Print the start of a node, and all its non node fields.
void	printStartScriptNode(AbstractDynamicFieldNode node, com.sun.xml.fastinfoset.sax.AttributesHolder atts, boolean use, Map<VRMLNode,String> defMap, Map<Integer,List<ProtoFieldInfo>> isMap)	Print the start of a node, and all its non node fields.
void	setPrintDocType(boolean enable)	Set the flag indicating that the doc type element should be included
void	setPrintXML(boolean enable)	Set the flag indicating that the xml element should be included
void	setX3DAttributes(Map<String,String> atts)	Set attributes to be added to the X3D tag.
void	traverse(VRMLNode source, boolean ignoreFirst)	Print a node and its children.
void	writeScene(VRMLScene scene)	Write a scene out.

Methods inherited from class org.web3d.vrml.export.BaseRetainedExporter

componentDecl, convertFieldData, endExternProtoDecl, endField, endNode, endProtoBody, endProtoDecl, endScriptDecl, exportDecl, externProtoURI, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, findIS, getPublicId, getSystemId, importDecl, loadContainerProperties, metaDecl, printDefMap, printIS, profileDecl, protoFieldDecl, protoIsDecl, reverseMap, routeDecl, scriptFieldDecl, setConvertOldContent, setDocumentLocator, startDocument, startExternProtoDecl, startField, startNode, startProtoBody, startProtoDecl, startScriptDecl, useDecl

Methods inherited from class org.web3d.vrml.export.Exporter

getLastErrorCode

Methods inherited from class java.lang.Object

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

Field Details

METHOD_FASTEST_PARSING

public static final int METHOD_FASTEST_PARSING

See Also:

• Constant Field Values

METHOD_SMALLEST_NONLOSSY

public static final int METHOD_SMALLEST_NONLOSSY

See Also:

• Constant Field Values

METHOD_SMALLEST_LOSSY

public static final int METHOD_SMALLEST_LOSSY

See Also:

• Constant Field Values

METHOD_STRINGS

public static final int METHOD_STRINGS

See Also:

• Constant Field Values

INDENT_STRING

protected static String INDENT_STRING

The indent String to replicate per level

BYTE_ALGORITHM_ID

protected static final int BYTE_ALGORITHM_ID

See Also:

• Constant Field Values

DELTA_ZLIB_INT_ARRAY_ALGORITHM_ID

protected static final int DELTA_ZLIB_INT_ARRAY_ALGORITHM_ID

See Also:

• Constant Field Values

EMPTY_MAP

protected Map EMPTY_MAP

An empty map to avoid null testing

indent

protected int indent

The current indent level

indentString

protected String indentString

The current indent string

indentMap

protected org.j3d.util.IntHashMap<String> indentMap

A mapping of indent to String

usedNodes

protected Set<VRMLNodeType> usedNodes

Temporary map during traversal for use references

filterWriter

protected Writer filterWriter

The passed in writer

protoDeclSet

protected Set<PrototypeDecl> protoDeclSet

The current set of proto definitions

traverser

protected SceneGraphTraverser traverser

Traverser for printing proto's

root

protected VRMLWorldRootNodeType root

The world root

printDocType

protected boolean printDocType

Should we print the DOCTYPE

printXML

protected boolean printXML

Should we print the XML Element

useNC

protected boolean useNC

Should we use node compressors

ignoreData

protected boolean ignoreData

Should we ignore data, its handled by the compressor

protoMap

protected Map<String,VRMLFieldDeclaration> protoMap

Single level proto map

currentCompressor

protected NodeCompressor currentCompressor

The current compressor. Needs to change to a generic interface

compressedAttWay

protected boolean compressedAttWay

Switch between methods, should go away

handler

protected ContentHandler handler

The contentHandler to write to

compressionMethod

protected int compressionMethod

The compression method to use for binary

quantizeParam

protected float quantizeParam

The float lossy param

binary

protected boolean binary

Are we exporting to binary

x3dAtts

protected Map<String,String> x3dAtts

Extra attributes on the X3D tag

compress

protected boolean compress

Should we strip all unnecessary characters

Constructor Details

X3DRetainedSAXExporter

public X3DRetainedSAXExporter(int major,
 int minor,
 org.j3d.util.ErrorReporter errorReporter,
 int compressionMethod,
 float quantizeParam)

Create a new exporter for the given spec version

Parameters:

major - The major version number of this scene

minor - The minor version number of this scene

errorReporter - The error reporter to use

compressionMethod -

quantizeParam -

X3DRetainedSAXExporter

public X3DRetainedSAXExporter(int major,
 int minor,
 org.j3d.util.ErrorReporter errorReporter,
 int compressionMethod,
 float quantizeParam,
 int sigDigits)

Create a new exporter for the given spec version

Parameters:

major - The major version number of this scene

minor - The minor version number of this scene

errorReporter - The error reporter to use

compressionMethod -

quantizeParam -

sigDigits -

Method Details

setX3DAttributes

public void setX3DAttributes(Map<String,String> atts)

Set attributes to be added to the X3D tag. Useful for namespace management.

Parameters:

atts - The attributes to add

setPrintDocType

public void setPrintDocType(boolean enable)

Set the flag indicating that the doc type element should be included

Parameters:

enable - Flag indicating whether the doc type element should be included

getPrintDocType

public boolean getPrintDocType()

Return the flag indicating that the doc type element is to be included

Returns:

Whether the doc type element is to be included

setPrintXML

public void setPrintXML(boolean enable)

Set the flag indicating that the xml element should be included

Parameters:

enable - Flag indicating whether the xml element should be included

getPrintXML

public boolean getPrintXML()

Return the flag indicating that the xml element is to be included

Returns:

Whether the xml element is to be included

createX3DString

protected String createX3DString(VRMLFieldDeclaration decl,
 float[] val,
 int numElements)

Create an X3D string from an array of values

Parameters:

decl - The declaration

val - The value

numElements - The number of elements which make up a single value(ie 3 for MFVec3f)

Returns:

The value as a string

createX3DString

protected String createX3DString(VRMLFieldDeclaration decl,
 double[] val,
 int numElements)

Create an X3D string from an array of values

Parameters:

decl - The declaration

val - The value

numElements - The number of elements which make up a single value(ie 3 for MFVec3f)

Returns:

The value as a string

createX3DString

protected String createX3DString(VRMLFieldDeclaration decl,
 int[] val,
 int numElements)

Create an X3D string from an array of values

Parameters:

decl - The declaration

val - The value

numElements - The number of elements which make up a single value(ie 3 for MFVec3f)

Returns:

The value as a string

encodeFloatArray

protected void encodeFloatArray(float[] fval,
 int numElements,
 VRMLFieldDeclaration decl,
 String qName,
 com.sun.xml.fastinfoset.sax.AttributesHolder aholder,
 int ftype)

Encode float array data. This base version will just use a string rep

Parameters:

fval - The parsed float array value

numElements - The number of elements per item

decl - The field declaration.

qName - The qualified name

aholder - The current attributes holder

ftype - The X3D field type, defined in FieldConstants

encodeDoubleArray

protected void encodeDoubleArray(double[] fval,
 int numElements,
 VRMLFieldDeclaration decl,
 String qName,
 com.sun.xml.fastinfoset.sax.AttributesHolder aholder,
 int ftype)

Encode double array data. This base version will just use a string rep.

Parameters:

fval - The parsed double array value

numElements - The number of elements per item

decl - The field declaration.

qName - The qualified name

aholder - The current attributes holder

ftype - The X3D field type, defined in FieldConstants

writeScene

public void writeScene(VRMLScene scene)

Write a scene out.

Parameters:

scene - The scene to write

endDocument

public void endDocument()
                 throws SAVException,
VRMLException

Declaration of the end of the document. There will be no further parsing and hence events after this.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class BaseRetainedExporter

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

printHeader

public void printHeader(int major,
 int minor)

Print the header.

Specified by:

printHeader in class BaseRetainedExporter

Parameters:

major - The major version

minor - The minor version

printExporterInfo

public void printExporterInfo()

Description copied from class: BaseRetainedExporter

Print identifying information about this exporter

Specified by:

printExporterInfo in class BaseRetainedExporter

printProfile

public void printProfile(String profile)

Print the profile decl.

Specified by:

printProfile in class BaseRetainedExporter

Parameters:

profile - The profile

printComponents

public void printComponents(ComponentInfo[] comps)

Print the component decl

Specified by:

printComponents in class BaseRetainedExporter

Parameters:

comps - The component list

printMetaData

public void printMetaData(Map<String,String> meta)

Print the MetaData.

Specified by:

printMetaData in class BaseRetainedExporter

Parameters:

meta - The scene Metadata map

printROUTE

public void printROUTE(ROUTE route,
 Map<VRMLNode,String> defMap)

Print a ROUTE statement.

Specified by:

printROUTE in class BaseRetainedExporter

Parameters:

route - The ROUTE to print

defMap - The DEF map

printExports

public void printExports(Map<String,String> exports)

Print Exports.

Specified by:

printExports in class BaseRetainedExporter

Parameters:

exports - A map of exports(name,AS).

printImports

public void printImports(Map<String,VRMLNode> imports)

Print Imports.

Specified by:

printImports in class BaseRetainedExporter

Parameters:

imports - A map of imports(exported, String[] {def, as}.

traverse

public void traverse(VRMLNode source,
 boolean ignoreFirst)

Print a node and its children.

Parameters:

source - The root node

ignoreFirst - Should we ignore the first node. Used for WorldRoot and ProtoBody

printStartScriptNode

public void printStartScriptNode(AbstractDynamicFieldNode node,
 com.sun.xml.fastinfoset.sax.AttributesHolder atts,
 boolean use,
 Map<VRMLNode,String> defMap,
 Map<Integer,List<ProtoFieldInfo>> isMap)

Print the start of a node, and all its non node fields.

Parameters:

node - The node to print

atts - The current attributes if applicable

use - Is it a USE

defMap - The current mapping of nodes to DEF names

isMap - The current mapping of fields to IS names

printStartNode

public boolean printStartNode(VRMLNodeType node,
 boolean use,
 Map<VRMLNode,String> defMap,
 Map<Integer,List<ProtoFieldInfo>> isMap,
 String containerField,
 boolean compressed)

Print the start of a node, and all its non node fields.

Parameters:

node - The node to print

use - Is it a USE

defMap - The current mapping of nodes to DEF names

isMap - The current mapping of fields to IS names

containerField - The container field value, null if not needed

compressed - Is this the start of a sg compression

Returns:

Did a protoInstance start at this level

printEndNode

public void printEndNode(VRMLNodeType node,
 boolean hadChildren,
 boolean compressed,
 Map<Integer,List<ProtoFieldInfo>> isMap)
                  throws SAXException

Print the end of a node.

Parameters:

node - The node

hadChildren - Where there any children nodes

compressed - Is this node compressed

isMap - The current isMap

Throws:

SAXException

observedNode

public void observedNode(VRMLNodeType parent,
 VRMLNodeType child,
 int field,
 boolean used)

Notification of a child node.

Specified by:

observedNode in interface SceneGraphTraversalSimpleObserver

Parameters:

parent - The parent node of this node

child - The child node that is being observed

field - The index of the child field in its parent node

used - true if the node reference is actually a USE

printPrototypeDecl

public void printPrototypeDecl(PrototypeDecl proto)

Print a proto declaration.

Specified by:

printPrototypeDecl in class BaseRetainedExporter

Parameters:

proto - The decl to print

printExternalPrototypeDecl

public void printExternalPrototypeDecl(CRExternPrototypeDecl proto)

Print an external proto declaration.

Parameters:

proto - The decl to print