Package org.web3d.x3d.jsail

Class ConfigurationProperties

java.lang.Object

org.web3d.x3d.jsail.ConfigurationProperties

public class ConfigurationProperties
extends Object

Utility class that enables developers to set custom configuration properties when using X3D Java SAI Library (X3DJSAIL). Note use of static methods.

Utility methods and command-line support are available to load Java .property files, such as X3DJSAIL.properties.template for user preferences.

Output serialization support is provided for indentation, X3D Compressed Binary Encoding: X3D Canonical Form, showing default attribute values, and other custom settings.

See Also:

• X3D Canonicalization (C14N) Tool
• Java Tutorials: Understanding (Static) Class Members
• Java Tutorials: The Singleton Design Pattern
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	creationConnectionValidationExceptionAllowed_DEFAULT	Set whether to allow partial output if validation exception occurs when creating an object, initial value is true.
static boolean	debugModeActive	Default mode for debugging results, initial value is false.
static final String	ERROR_CONFIGURATION_X3DJSAIL	Error message if configuration of X3DJSAIL is incorrect: CLASSPATH missing jar, or other error.
static final String	ERROR_ILLEGAL_VALUE	Error message if an illegal value is provided as a method parameter.
static final String	ERROR_NODE_NOT_FOUND	Error message if a node is required but no reference is found.
static final String	ERROR_NOT_CONNECTED_TO_SCENE_GRAPH	Error message if an element is not currently connected to an existing scene graph object, and necessary checking for model validation is not possible.
static final String	ERROR_UNKNOWN_EXTERNPROTODECLARE_NODE_TYPE	Error message if node type of ExternProtoDeclare is not found.
static final String	ERROR_UNKNOWN_FIELD_ACCESSTYPE	Error message if incorrect field accessType value encountered.
static final String	ERROR_UNKNOWN_FIELD_TYPE	Error message if incorrect field type value encountered.
static final String	ERROR_UNKNOWN_PROTODECLARE_NODE_TYPE	Error message if node type of ProtoDeclare is not found.
static final String	ERROR_UNKNOWN_PROTOINSTANCE_NODE_TYPE	Error message if node type of ProtoInstance is not found.
static final String	ERROR_VALUE_NOT_FOUND	Error message if a field is required but no value is found.
static final String	EXI_ENGINE_EXIFICIENT	XSLT transformation engine: EXIficient (default).
static final String	EXI_ENGINE_OPENEXI	EXI transformation engine: OpenEXI Nagasena.
static final char	indentCharacter_DEFAULT	Default character for indenting when serializing scene output, initial value is indentCharacter_SPACE.
static final char	indentCharacter_SPACE	Whitespace character for indenting when serializing scene output.
static final char	indentCharacter_TAB	Alternative whitespace character for indenting when serializing scene output.
static final int	indentIncrement_DEFAULT	Default character-count increment for serializing scene output.
static final String	NAME_X3DJSAIL	X3DJSAIL name
static final boolean	normalizeCommentWhitespace_DEFAULT	Set whether to normalize whitespace in comments, which can aid consistency in canonicalization and security; default value is true.
static final boolean	overwriteExistingFiles_DEFAULT	Set whether to allow overwriting previously existing files, initial value is true.
static final String	PROPERTIES_FILENAME_DEFAULT	Default name of properties file: X3DJSAIL.properties
static final boolean	SFImagePixelOutputHexadecimal_DEFAULT	Whether SFImage pixel output values are in hexadecimal format when serializing scene output, initial value is true.
static final boolean	stripDefaultAttributes_DEFAULT	Whether to strip default attribute values when serializing scene output, initial value is true;.
static final String	STYLESHEET_COBWEB	Deprecated.
static final String	STYLESHEET_ExtrusionCrossSectionSVG	XSLT stylesheet to create Extrusion node cross sections in SVG from X3D scene: ..

Constructor Summary

Constructors

Constructor	Description
ConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
static String	getClassPath()	Get current system CLASSPATH value.
static final String	getExiEngine()	Get preference for XSLT transformation engine to use: EXI_ENGINE_EXIFICIENT or EXI_ENGINE_OPENEXI.
static String	getExpectedOutputFileExtension(String stylesheetName)	Determine expected output filename extension based on stylesheet conversion.
static char	getIndentCharacter()	Get indentCharacter used when serializing scene output.
static int	getIndentIncrement()	Get number of indent characters (space or tab characters) to indent when serializing scene output.
static String	getPropertiesFileName()	Get name of current properties file (optional directory path plus file name).
static boolean	getStripDefaultAttributes()	Indicate whether default attributes (and their values) are stripped when serializing scene output.
static final String	getXsltEngine()	Get preference for XSLT transformation engine to use: XSLT_ENGINE_SAXON or XSLT_ENGINE_NATIVE_JAVA.
static final void	initialize()	Initialize this ConfigurationProperties instance to default values.
static boolean	isCreationConnectionValidationExceptionAllowed()	Indicate whether continuation is allowed if validation exception occurs when creating an object.
static boolean	isDebugModeActive()	Indicate whether debug mode is active.
static final boolean	isDeleteIntermediateFiles()	Indicate whether to delete intermediate files generated as part of various transformations, this property method can be helpful can be helpful for debugging.
static boolean	isNormalizeCommentWhitespace()	Indicate whether to normalize whitespace in comments, which can aid consistency in canonicalization and security.
static boolean	isOverwriteExistingFiles()	Indicate whether to allow overwriting previously existing files.
static boolean	isSFImagePixelOutputHexadecimal()	Indicate whether SFImage pixel output values are in hexadecimal format when serializing scene output.
static final boolean	isStripTrailingZeroes()	Indicates whether trailing zeros are omitted from output of floating-point or double-precision values, this property can be helpful for debugging.
static boolean	isStylesheetSupported(String stylesheetName)	Check whether stylesheet is supported by X3DJSAIL.
static boolean	isValidationExceptionAllowed()	Indicate whether partial results are allowed if validation exception occurs when serializing scene output.
static boolean	isX3dCanonicalForm()	Indicate whether X3D Canonical Form is used for toStringX3D() XML output.
static void	loadProperties()	Update settings in this ConfigurationProperties instance using values in property file.
static void	setCreationConnectionValidationExceptionAllowed(boolean newCreationConnectionValidationExceptionAllowed)	Set whether partial results are allowed (and operation continues) if validation exception occurs when creating an object.
static void	setDebugModeActive(boolean newDebugModeActive)	Set whether debug mode is active.
static final void	setDeleteIntermediateFiles(boolean newValue)	Set whether to delete intermediate files generated as part of various transformations, this property method can be helpful can be helpful for debugging.
static final void	setExiEngine(String newValue)	Set preference for EXI transformation engine to use: EXI_ENGINE_EXIFICIENT or EXI_ENGINE_OPENEXI.
static void	setIndentCharacter(char newIndentCharacter)	Set indentCharacter used when serializing scene output.
static void	setIndentIncrement(int newIndentIncrement)	Set number of characters to indent when serializing scene output.
static void	setNormalizeCommentWhitespace(boolean newNormalizeCommentWhitespace)	Set whether to normalize whitespace in comments, which can aid consistency in canonicalization and security.
static void	setOverwriteExistingFiles(boolean newOverwriteExistingFiles)	Set whether to allow overwriting previously existing files.
static void	setPropertiesFileName(String fileName)	Set name of properties file (optional directory path plus file name).
static void	setSFImagePixelOutputHexadecimal(boolean newSFImagePixelOutputHexadecimal)	Set whether SFImage pixel output values are in hexadecimal format when serializing scene output.
static void	setStripDefaultAttributes(boolean newStripDefaultAttributes)	Set whether default attributes (and their values) are stripped when serializing scene output.
static final void	setStripTrailingZeroes(boolean newValue)	Set whether to omit trailing zeros from floating-point or double-precision output, this property can be helpful for debugging.
static void	setValidationExceptionAllowed(boolean newValidationExceptionAllowed)	Set whether partial results are allowed (and operation continues) if validation exception occurs when serializing scene output.
static void	setX3dCanonicalForm()	Ensure that X3D Canonical Form is used for XML output, resetting default values for indentation.
static final void	setXsltEngine(String newValue)	Set preference for XSLT transformation engine to use: XSLT_ENGINE_SAXON or XSLT_ENGINE_NATIVE_JAVA.

Methods inherited from class java.lang.Object

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

Field Details

indentIncrement_DEFAULT

public static final int indentIncrement_DEFAULT

Default character-count increment for serializing scene output.

See Also:

• Constant Field Values

indentCharacter_SPACE

public static final char indentCharacter_SPACE

Whitespace character for indenting when serializing scene output.

See Also:

• Constant Field Values

indentCharacter_TAB

public static final char indentCharacter_TAB

Alternative whitespace character for indenting when serializing scene output.

See Also:

• Constant Field Values

indentCharacter_DEFAULT

public static final char indentCharacter_DEFAULT

Default character for indenting when serializing scene output, initial value is indentCharacter_SPACE.

See Also:

• Constant Field Values

XML_ENCODING_DECLARATION_DEFAULT

public static final String XML_ENCODING_DECLARATION_DEFAULT

Default XML document encoding, used in the XML document declaration appearing in the first line of an XML file.

See Also:

• X3D Tooltips: X3D
• X3D Scene Authoring Hints: Validation of X3D Scenes using DTD and XML Schema
• Constant Field Values

ERROR_CONFIGURATION_X3DJSAIL

public static final String ERROR_CONFIGURATION_X3DJSAIL

Error message if configuration of X3DJSAIL is incorrect: CLASSPATH missing jar, or other error.

See Also:

• Constant Field Values

WARNING_CONFIGURATION_X3DJSAIL

public static final String WARNING_CONFIGURATION_X3DJSAIL

Warning message if configuration of X3DJSAIL is incorrect: properties file missing, or other error.

See Also:

• Constant Field Values

WARNING_MESSAGE

public static final String WARNING_MESSAGE

Warning message if model information is unexpected or missing.

See Also:

• Constant Field Values

ERROR_ILLEGAL_VALUE

public static final String ERROR_ILLEGAL_VALUE

Error message if an illegal value is provided as a method parameter.

See Also:

• Constant Field Values

ERROR_NOT_CONNECTED_TO_SCENE_GRAPH

public static final String ERROR_NOT_CONNECTED_TO_SCENE_GRAPH

Error message if an element is not currently connected to an existing scene graph object, and necessary checking for model validation is not possible. Example: field or fieldValue creation may fail validation() if the field types cannot be checked in a corresponding ProtoDeclare or ExternProtoDeclare.

See Also:

• Constant Field Values

ERROR_VALUE_NOT_FOUND

public static final String ERROR_VALUE_NOT_FOUND

Error message if a field is required but no value is found.

See Also:

• Constant Field Values

ERROR_NODE_NOT_FOUND

public static final String ERROR_NODE_NOT_FOUND

Error message if a node is required but no reference is found.

See Also:

• Constant Field Values

ERROR_UNKNOWN_FIELD_ACCESSTYPE

public static final String ERROR_UNKNOWN_FIELD_ACCESSTYPE

Error message if incorrect field accessType value encountered.

See Also:

• field.getAccessType()
• X3D Tooltips: accessType
• Constant Field Values

ERROR_UNKNOWN_FIELD_TYPE

public static final String ERROR_UNKNOWN_FIELD_TYPE

Error message if incorrect field type value encountered.

See Also:

• field.getType()
• X3D Tooltips: type
• Constant Field Values

ERROR_UNKNOWN_PROTODECLARE_NODE_TYPE

public static final String ERROR_UNKNOWN_PROTODECLARE_NODE_TYPE

Error message if node type of ProtoDeclare is not found.

See Also:

• ProtoDeclare
• ExternProtoDeclare
• ProtoInstance
• X3D SAI: B.7.13 InvalidProtoException
• Constant Field Values

ERROR_UNKNOWN_EXTERNPROTODECLARE_NODE_TYPE

public static final String ERROR_UNKNOWN_EXTERNPROTODECLARE_NODE_TYPE

Error message if node type of ExternProtoDeclare is not found.

See Also:

• ExternProtoDeclare
• ProtoDeclare
• ProtoInstance
• X3D SAI: B.7.13 InvalidProtoException
• Constant Field Values

ERROR_UNKNOWN_PROTOINSTANCE_NODE_TYPE

public static final String ERROR_UNKNOWN_PROTOINSTANCE_NODE_TYPE

Error message if node type of ProtoInstance is not found.

See Also:

• ProtoInstance
• ProtoDeclare
• ExternProtoDeclare
• X3D SAI: B.7.13 InvalidProtoException
• Constant Field Values

WARNING_PROTOINSTANCE_NOT_FOUND

public static final String WARNING_PROTOINSTANCE_NOT_FOUND

Warning message if a ProtoInstance corresponding to a given ProtoDeclare or ExternProtoDeclare is not found.

See Also:

• ProtoInstance
• ProtoDeclare
• ExternProtoDeclare
• Constant Field Values

debugModeActive

public static boolean debugModeActive

Default mode for debugging results, initial value is false.

SFImagePixelOutputHexadecimal_DEFAULT

public static final boolean SFImagePixelOutputHexadecimal_DEFAULT

Whether SFImage pixel output values are in hexadecimal format when serializing scene output, initial value is true.

See Also:

• Constant Field Values

stripDefaultAttributes_DEFAULT

public static final boolean stripDefaultAttributes_DEFAULT

Whether to strip default attribute values when serializing scene output, initial value is true;.

See Also:

• Constant Field Values

validationExceptionAllowed_DEFAULT

public static final boolean validationExceptionAllowed_DEFAULT

Set whether to allow partial output if validation exception occurs when serializing scene output, initial value is false.

See Also:

• Constant Field Values

creationConnectionValidationExceptionAllowed_DEFAULT

public static final boolean creationConnectionValidationExceptionAllowed_DEFAULT

Set whether to allow partial output if validation exception occurs when creating an object, initial value is true.

See Also:

• Constant Field Values

normalizeCommentWhitespace_DEFAULT

public static final boolean normalizeCommentWhitespace_DEFAULT

Set whether to normalize whitespace in comments, which can aid consistency in canonicalization and security; default value is true.

See Also:

• setNormalizeCommentWhitespace(boolean)
• isNormalizeCommentWhitespace()
• Constant Field Values

overwriteExistingFiles_DEFAULT

public static final boolean overwriteExistingFiles_DEFAULT

Set whether to allow overwriting previously existing files, initial value is true.

See Also:

• Constant Field Values

NAME_X3DJSAIL

public static final String NAME_X3DJSAIL

X3DJSAIL name

See Also:

• https://www.web3d.org/specifications/java/X3DJSAIL.html
• Constant Field Values

VERSION_DATE

public static final String VERSION_DATE

Date this version of X3DJSAIL was autogenerated: "4 July 2022".

See Also:

• https://www.web3d.org/specifications/java/X3DJSAIL.html
• Constant Field Values

URL_X3DJSAIL

public static final String URL_X3DJSAIL

X3DJSAIL documentation page

See Also:

• https://www.web3d.org/specifications/java/X3DJSAIL.html
• Constant Field Values

URL_X3DRESOURCES

public static final String URL_X3DRESOURCES

X3D Resources documentation page

See Also:

• https://www.web3d.org/x3d/content/examples/X3dResources.html
• Constant Field Values

URL_X3DSCENEAUTHORINGHINTS

public static final String URL_X3DSCENEAUTHORINGHINTS

X3D Scene Authoring Hints documentation pages

See Also:

• X3D Scene Authoring Hints
• Constant Field Values

URL_X3DREGEXES

public static final String URL_X3DREGEXES

X3D Regular Expressions (regexes) documentation pages

See Also:

• X3D Regular Expressions (regexes)
• Constant Field Values

URL_X3DTOOLTIPS

public static final String URL_X3DTOOLTIPS

X3D Tooltips documentation pages

See Also:

• https://www.web3d.org/x3d/tooltips/X3dTooltips.html
• X3D Resources: Tooltips (multiple languages)
• Constant Field Values

URL_X3DUOM

public static final String URL_X3DUOM

X3D Unified Object Model (X3DUOM) documentation page

See Also:

• X3D Unified Object Model (X3DUOM)
• Constant Field Values

STYLESHEET_HTML_DOCUMENTATION

public static final String STYLESHEET_HTML_DOCUMENTATION

XSLT stylesheet to create pretty-print HTML documentation page from X3D scene: ../lib/stylesheets/X3dToXhtml.xslt

See Also:

• X3dToXhtml.xslt
• examples/HelloWorldProgramOutput.html
• Constant Field Values

STYLESHEET_VRML97

public static final String STYLESHEET_VRML97

XSLT stylesheet to create VRML97 model from X3D scene: ../lib/stylesheets/X3dToVrml.xslt

See Also:

• X3dToVrml97.xslt
• examples/HelloWorldProgramOutput.wrl
• Constant Field Values

STYLESHEET_X3DV_CLASSICVRML

public static final String STYLESHEET_X3DV_CLASSICVRML

XSLT stylesheet to create VRML97 model from X3D scene: ../lib/stylesheets/X3dToX3dvClassicVrmlEncoding.xslt

See Also:

• X3dToX3dvClassicVrmlEncoding.xslt
• examples/HelloWorldProgramOutput.x3dv
• Constant Field Values

STYLESHEET_MODEL_META_TO_MARKDOWN

public static final String STYLESHEET_MODEL_META_TO_MARKDOWN

XSLT stylesheet to create model meta information as markdown: ../lib/stylesheets/X3dModelMetaToMarkdown.xslt

See Also:

• X3dModelMetaToMarkdown.xslt
• examples/HelloWorldProgramOutput.md
• Constant Field Values

STYLESHEET_X3DTIDY

public static final String STYLESHEET_X3DTIDY

XSLT stylesheet to create X3D-Tidy cleaned-up version of X3D scene: ../lib/stylesheets/X3dToXhtml.xslt

See Also:

• X3D Tidy for Scene Cleanup, Corrections and Modifications
• X3dTidy.xslt
• examples/HelloWorldProgramOutputTidy.x3d
• Constant Field Values

STYLESHEET_ExtrusionCrossSectionSVG

public static final String STYLESHEET_ExtrusionCrossSectionSVG

XSLT stylesheet to create Extrusion node cross sections in SVG from X3D scene: ../lib/stylesheets/X3dExtrusionCrossSectionToSvg.xslt

See Also:

• Constant Field Values

STYLESHEET_X3DOM

public static final String STYLESHEET_X3DOM

XSLT stylesheet to create X3DOM XHTML page or X3DOM HTML page from X3D scene: ../lib/stylesheets/X3dToX3dom.xslt

See Also:

• X3dToX3dom.xslt
• examples/HelloWorldProgramOutputX3dom.html
• Constant Field Values

STYLESHEET_X_ITE

public static final String STYLESHEET_X_ITE

XSLT stylesheet to create X_ITE XHTML page or X_ITE HTML page from X3D scene: ../lib/stylesheets/X3dToX3dom.xslt TODO disambiguation needed?

See Also:

• X_ITE open-source X3D player
• X3dToX3dom.xslt
• examples/HelloWorldProgramOutputX_ITE.html
• Constant Field Values

STYLESHEET_COBWEB

@Deprecated
public static final String STYLESHEET_COBWEB

Deprecated.

XSLT stylesheet Cobweb (now X_ITE)

See Also:

• X_ITE open-source X3D player
• Constant Field Values

STYLESHEET_JAVA

public static final String STYLESHEET_JAVA

XSLT stylesheet to create Java source code (using X3DJSAIL library) from X3D scene: ../lib/stylesheets/X3dToJava.xslt. TODO: documentation.

See Also:

• X3dToJava.xslt
• examples/HelloWorldProgramOutput.java
• Constant Field Values

STYLESHEET_JAVASCRIPT

public static final String STYLESHEET_JAVASCRIPT

XSLT stylesheet to create Javascript (ECMAScript) source code (using X3DJSAIL library) from X3D scene: ../lib/stylesheets/X3dToNodeJS.xslt. TODO: documentation.

See Also:

• X3dToNodeJS.xslt
• examples/HelloWorldProgramOutput.java
• Constant Field Values

STYLESHEET_JSON

public static final String STYLESHEET_JSON

XSLT stylesheet to create JSON encoding from X3D scene: ../lib/stylesheets/X3dToJson.xslt

See Also:

• X3D JSON Encoding
• X3D to JSON Stylesheet Converter
• X3dToJson.xslt
• examples/HelloWorldProgramOutput.json
• Constant Field Values

STYLESHEET_PYTHON

public static final String STYLESHEET_PYTHON

XSLT stylesheet to create Python source from X3D scene: ../lib/stylesheets/X3dToPython.xslt

See Also:

• X3dToPython.xslt
• examples/HelloWorldProgramOutput.py
• Constant Field Values

X3DJSAIL_JAR_RELEASE_VERSIONS

public static final ArrayList<String> X3DJSAIL_JAR_RELEASE_VERSIONS

List of officially released X3DJSAIL jar files.X3D

XSLT_ENGINE_SAXON

public static final String XSLT_ENGINE_SAXON

XSLT transformation engine: SAXON (default).

See Also:

• Saxon-HE 9.7
• Saxon distribution
• Saxonica > Saxon > Using XSLT > Invoking XSLT from an application
• Constant Field Values

XSLT_ENGINE_NATIVE_JAVA

public static final String XSLT_ENGINE_NATIVE_JAVA

XSLT transformation engine: native Java.

See Also:

• Java Tutorials: Transforming XML Data with XSLT
• Java Tutorials: Transforming XML Data with XSLT, sample files
• Buffered I/O Methods for Text Files
• Constant Field Values

EXI_ENGINE_OPENEXI

public static final String EXI_ENGINE_OPENEXI

EXI transformation engine: OpenEXI Nagasena. Warning: testing in progress.

See Also:

• OpenEXI Nagasena
• Nagasena Tutorial
• Video: OpenEXI, A Quick Introduction
• getExiEngine()
• setExiEngine(String)
• EXI_ENGINE_EXIFICIENT
• Constant Field Values

EXI_ENGINE_EXIFICIENT

public static final String EXI_ENGINE_EXIFICIENT

XSLT transformation engine: EXIficient (default).

See Also:

• EXIficient project page
• EXIficient README
• getExiEngine()
• setExiEngine(String)
• EXI_ENGINE_OPENEXI
• Constant Field Values

PROPERTIES_FILENAME_DEFAULT

public static final String PROPERTIES_FILENAME_DEFAULT

Default name of properties file: X3DJSAIL.properties

See Also:

• getPropertiesFileName()
• setPropertiesFileName(String)
• loadProperties()
• Constant Field Values

Constructor Details

ConfigurationProperties

public ConfigurationProperties()

Method Details

isStylesheetSupported

public static boolean isStylesheetSupported(String stylesheetName)

Check whether stylesheet is supported by X3DJSAIL.

Parameters:

stylesheetName - XSLT stylesheet to apply

Returns:

whether stylesheet is supported by X3DJSAIL

getExpectedOutputFileExtension

public static String getExpectedOutputFileExtension(String stylesheetName)

Determine expected output filename extension based on stylesheet conversion.

Parameters:

stylesheetName - XSLT stylesheet being applied

Returns:

expected output filename extension

isDeleteIntermediateFiles

public static final boolean isDeleteIntermediateFiles()

Indicate whether to delete intermediate files generated as part of various transformations, this property method can be helpful can be helpful for debugging.

Returns:

configuration setting whether intermediate files are deleted

setDeleteIntermediateFiles

public static final void setDeleteIntermediateFiles(boolean newValue)

Set whether to delete intermediate files generated as part of various transformations, this property method can be helpful can be helpful for debugging.

Parameters:

newValue - is new value to assign

isStripTrailingZeroes

public static final boolean isStripTrailingZeroes()

Indicates whether trailing zeros are omitted from output of floating-point or double-precision values, this property can be helpful for debugging.

Returns:

configuration setting whether trailing zeros are stripped

setStripTrailingZeroes

public static final void setStripTrailingZeroes(boolean newValue)

Set whether to omit trailing zeros from floating-point or double-precision output, this property can be helpful for debugging.

Parameters:

newValue - is new value to assign

getXsltEngine

public static final String getXsltEngine()

Get preference for XSLT transformation engine to use: XSLT_ENGINE_SAXON or XSLT_ENGINE_NATIVE_JAVA.

Returns:

String constant regarding current configuration: XSLT_ENGINE_SAXON (default) or XSLT_ENGINE_NATIVE_JAVA

setXsltEngine

public static final void setXsltEngine(String newValue)

Set preference for XSLT transformation engine to use: XSLT_ENGINE_SAXON or XSLT_ENGINE_NATIVE_JAVA.

Parameters:

newValue - is new value to assign

getExiEngine

public static final String getExiEngine()

Get preference for XSLT transformation engine to use: EXI_ENGINE_EXIFICIENT or EXI_ENGINE_OPENEXI.

Returns:

String constant regarding current configuration: EXI_ENGINE_EXIFICIENT} (default) or EXI_ENGINE_OPENEXI

See Also:

• EXI_ENGINE_EXIFICIENT
• EXI_ENGINE_OPENEXI
• setExiEngine(String)

setExiEngine

public static final void setExiEngine(String newValue)

Set preference for EXI transformation engine to use: EXI_ENGINE_EXIFICIENT or EXI_ENGINE_OPENEXI.

Parameters:

newValue - is new value to assign

See Also:

• EXI_ENGINE_EXIFICIENT
• EXI_ENGINE_OPENEXI
• getExiEngine()

initialize

public static final void initialize()

Initialize this ConfigurationProperties instance to default values.

setPropertiesFileName

public static void setPropertiesFileName(String fileName)

Set name of properties file (optional directory path plus file name).

Parameters:

fileName - new name of properties file to load and parse

See Also:

• PROPERTIES_FILENAME_DEFAULT
• getPropertiesFileName()
• loadProperties()

getPropertiesFileName

public static String getPropertiesFileName()

Get name of current properties file (optional directory path plus file name).

Returns:

name of properties file to load and parse

See Also:

• PROPERTIES_FILENAME_DEFAULT
• setPropertiesFileName(String)
• loadProperties()

loadProperties

public static void loadProperties()

Update settings in this ConfigurationProperties instance using values in property file.

See Also:

• PROPERTIES_FILENAME_DEFAULT
• getPropertiesFileName()
• setPropertiesFileName(String)
• Java Tutorials: Properties
• Javadoc: java.util.Properties

getClassPath

public static String getClassPath()

Get current system CLASSPATH value. Note that a current version of X3DJSAIL.*.jar is expected to be in the current CLASSPATH.

Returns:

system CLASSPATH value.

See Also:

• Java documentation: Setting the Class Path
• Java Tutorials: PATH and CLASSPATH

getIndentCharacter

public static char getIndentCharacter()

Get indentCharacter used when serializing scene output.

Returns:

indentCharacter (either indentCharacter_SPACE or indentCharacter_TAB).

See Also:

• setIndentCharacter(char)
• setIndentIncrement(int)

setIndentCharacter

public static void setIndentCharacter(char newIndentCharacter)

Set indentCharacter used when serializing scene output.

Parameters:

newIndentCharacter - is new indent value (non-negative).

See Also:

• setX3dCanonicalForm()

getIndentIncrement

public static int getIndentIncrement()

Get number of indent characters (space or tab characters) to indent when serializing scene output.

Returns:

number of characters (non-negative).

See Also:

• setIndentCharacter(char)
• setIndentIncrement(int)

setIndentIncrement

public static void setIndentIncrement(int newIndentIncrement)

Set number of characters to indent when serializing scene output.

Parameters:

newIndentIncrement - is new indentIncrement value (non-negative).

See Also:

• setX3dCanonicalForm()

isX3dCanonicalForm

public static boolean isX3dCanonicalForm()

Indicate whether X3D Canonical Form is used for toStringX3D() XML output.

Returns:

whether X3D Canonical Form is used.

See Also:

• setIndentCharacter(char)
• setIndentIncrement(int)
• X3D Compressed binary encoding, 4.2.3 X3D canonical form
• Canonical XML
• Canonical EXI
• Apache Santuario
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

setX3dCanonicalForm

public static void setX3dCanonicalForm()

Ensure that X3D Canonical Form is used for XML output, resetting default values for indentation.

See Also:

• setIndentIncrement(int)
• setIndentCharacter(char)
• X3D Compressed binary encoding, 4.2.3 X3D canonical form
• Canonical XML
• Canonical EXI
• Apache Santuario
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

isDebugModeActive

public static boolean isDebugModeActive()

Indicate whether debug mode is active.

Returns:

whether debug mode is active.

setDebugModeActive

public static void setDebugModeActive(boolean newDebugModeActive)

Set whether debug mode is active.

Parameters:

newDebugModeActive - whether debug mode is active.

isSFImagePixelOutputHexadecimal

public static boolean isSFImagePixelOutputHexadecimal()

Indicate whether SFImage pixel output values are in hexadecimal format when serializing scene output.

Returns:

whether default attributes are shown.

setSFImagePixelOutputHexadecimal

public static void setSFImagePixelOutputHexadecimal(boolean newSFImagePixelOutputHexadecimal)

Set whether SFImage pixel output values are in hexadecimal format when serializing scene output.

Parameters:

newSFImagePixelOutputHexadecimal - whether SFImage pixel output values are in hexadecimal format.

getStripDefaultAttributes

public static boolean getStripDefaultAttributes()

Indicate whether default attributes (and their values) are stripped when serializing scene output.

Returns:

whether default attributes are shown.

setStripDefaultAttributes

public static void setStripDefaultAttributes(boolean newStripDefaultAttributes)

Set whether default attributes (and their values) are stripped when serializing scene output.

Parameters:

newStripDefaultAttributes - whether default attributes are shown.

isValidationExceptionAllowed

public static boolean isValidationExceptionAllowed()

Indicate whether partial results are allowed if validation exception occurs when serializing scene output.

Returns:

whether validation exceptions are allowed (and operation continues)

setValidationExceptionAllowed

public static void setValidationExceptionAllowed(boolean newValidationExceptionAllowed)

Set whether partial results are allowed (and operation continues) if validation exception occurs when serializing scene output. Can be useful technique for debugging, default value is false for strict operation. Warning: setting value to true permits creation of an invalid scene graph.

Parameters:

newValidationExceptionAllowed - whether validation exceptions are allowed (and operation continues)

isCreationConnectionValidationExceptionAllowed

public static boolean isCreationConnectionValidationExceptionAllowed()

Indicate whether continuation is allowed if validation exception occurs when creating an object. Warning: TODO experimental.

Returns:

whether validation exceptions are allowed (and operation continues) during object creation

setCreationConnectionValidationExceptionAllowed

public static void setCreationConnectionValidationExceptionAllowed(boolean newCreationConnectionValidationExceptionAllowed)

Set whether partial results are allowed (and operation continues) if validation exception occurs when creating an object. Can be useful technique for debugging, default value is true for permissive order of object creation. Warning: be sure to validate() this scene once construction is complete. Warning: TODO experimental.

Parameters:

newCreationConnectionValidationExceptionAllowed - whether validation exceptions are allowed (and object creation continues)

isNormalizeCommentWhitespace

public static boolean isNormalizeCommentWhitespace()

Indicate whether to normalize whitespace in comments, which can aid consistency in canonicalization and security.

Returns:

whether to normalize whitespace in comments

See Also:

• normalizeCommentWhitespace_DEFAULT
• setNormalizeCommentWhitespace(boolean)

setNormalizeCommentWhitespace

public static void setNormalizeCommentWhitespace(boolean newNormalizeCommentWhitespace)

Set whether to normalize whitespace in comments, which can aid consistency in canonicalization and security.

Parameters:

newNormalizeCommentWhitespace - whether to normalize whitespace in comments

See Also:

• normalizeCommentWhitespace_DEFAULT
• isNormalizeCommentWhitespace()

isOverwriteExistingFiles

public static boolean isOverwriteExistingFiles()

Indicate whether to allow overwriting previously existing files.

Returns:

whether creation of new files can overwrite prior versions

See Also:

• overwriteExistingFiles_DEFAULT

setOverwriteExistingFiles

public static void setOverwriteExistingFiles(boolean newOverwriteExistingFiles)

Set whether to allow overwriting previously existing files.

Parameters:

newOverwriteExistingFiles - whether creation of new files can overwrite prior versions

See Also:

• overwriteExistingFiles_DEFAULT