Package org.web3d.x3d.jsail

Class ConfigurationProperties

java.lang.Object
org.web3d.x3d.jsail.ConfigurationProperties
public class ConfigurationProperties
extends java.lang.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 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 java.lang.String ERROR_CONFIGURATION_X3DJSAIL
    Error message if configuration of X3DJSAIL is incorrect: CLASSPATH missing jar, or other error.
    static java.lang.String ERROR_ILLEGAL_VALUE
    Error message if an illegal value is provided as a method parameter.
    static java.lang.String ERROR_NODE_NOT_FOUND
    Error message if a node is required but no reference is found.
    static java.lang.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 java.lang.String ERROR_UNKNOWN_EXTERNPROTODECLARE_NODE_TYPE
    Error message if node type of ExternProtoDeclare is not found.
    static java.lang.String ERROR_UNKNOWN_FIELD_ACCESSTYPE
    Error message if incorrect field accessType value encountered.
    static java.lang.String ERROR_UNKNOWN_FIELD_TYPE
    Error message if incorrect field type value encountered.
    static java.lang.String ERROR_UNKNOWN_PROTODECLARE_NODE_TYPE
    Error message if node type of ProtoDeclare is not found.
    static java.lang.String ERROR_UNKNOWN_PROTOINSTANCE_NODE_TYPE
    Error message if node type of ProtoInstance is not found.
    static java.lang.String ERROR_VALUE_NOT_FOUND
    Error message if a field is required but no value is found.
    static java.lang.String EXI_ENGINE_EXIFICIENT
    XSLT transformation engine: EXIficient (default).
    static java.lang.String EXI_ENGINE_OPENEXI
    EXI transformation engine: OpenEXI Nagasena.
    static char indentCharacter_DEFAULT
    Default character for indenting when serializing scene output, initial value is indentCharacter_SPACE.
    static char indentCharacter_SPACE
    Whitespace character for indenting when serializing scene output.
    static char indentCharacter_TAB
    Alternative whitespace character for indenting when serializing scene output.
    static int indentIncrement_DEFAULT
    Default character-count increment for serializing scene output.
    static java.lang.String NAME_X3DJSAIL
    X3DJSAIL name
    static boolean normalizeCommentWhitespace_DEFAULT
    Set whether to normalize whitespace in comments, which can aid consistency in canonicalization and security; default value is true.
    static boolean overwriteExistingFiles_DEFAULT
    Set whether to allow overwriting previously existing files, initial value is true.
    static java.lang.String PROPERTIES_FILENAME_DEFAULT
    Default name of properties file: X3DJSAIL.properties
    static boolean SFImagePixelOutputHexadecimal_DEFAULT
    Whether SFImage pixel output values are in hexadecimal format when serializing scene output, initial value is true.
    static boolean stripDefaultAttributes_DEFAULT
    Whether to strip default attribute values when serializing scene output, initial value is true;.
    static java.lang.String STYLESHEET_COBWEB
    Deprecated.
    static java.lang.String STYLESHEET_ExtrusionCrossSectionSVG
    XSLT stylesheet to create Extrusion node cross sections in SVG from X3D scene: ..
    static java.lang.String STYLESHEET_HTML_DOCUMENTATION
    XSLT stylesheet to create pretty-print HTML documentation page from X3D scene: ..
    static java.lang.String STYLESHEET_JAVA
    XSLT stylesheet to create Java source code (using X3DJSAIL library) from X3D scene: ..
    static java.lang.String STYLESHEET_JAVASCRIPT
    XSLT stylesheet to create Javascript (ECMAScript) source code (using X3DJSAIL library) from X3D scene: ..
    static java.lang.String STYLESHEET_JSON
    XSLT stylesheet to create JSON encoding from X3D scene: ..
    static java.lang.String STYLESHEET_MODEL_META_TO_MARKDOWN
    XSLT stylesheet to create model meta information as markdown: ..
    static java.lang.String STYLESHEET_PYTHON
    XSLT stylesheet to create Python source from X3D scene: ..
    static java.lang.String STYLESHEET_VRML97
    XSLT stylesheet to create VRML97 model from X3D scene: ..
    static java.lang.String STYLESHEET_X_ITE
    XSLT stylesheet to create X_ITE XHTML page or X_ITE HTML page from X3D scene: ..
    static java.lang.String STYLESHEET_X3DOM
    XSLT stylesheet to create X3DOM XHTML page or X3DOM HTML page from X3D scene: ..
    static java.lang.String STYLESHEET_X3DTIDY
    XSLT stylesheet to create X3D-Tidy cleaned-up version of X3D scene: ..
    static java.lang.String STYLESHEET_X3DV_CLASSICVRML
    XSLT stylesheet to create VRML97 model from X3D scene: ..
    static java.lang.String URL_X3DJSAIL
    X3DJSAIL documentation page
    static java.lang.String URL_X3DREGEXES
    X3D Regular Expressions (regexes) documentation pages
    static java.lang.String URL_X3DRESOURCES
    X3D Resources documentation page
    static java.lang.String URL_X3DSCENEAUTHORINGHINTS
    X3D Scene Authoring Hints documentation pages
    static java.lang.String URL_X3DTOOLTIPS
    X3D Tooltips documentation pages
    static java.lang.String URL_X3DUOM
    X3D Unified Object Model (X3DUOM) documentation page
    static boolean validationExceptionAllowed_DEFAULT
    Set whether to allow partial output if validation exception occurs when serializing scene output, initial value is false.
    static java.lang.String VERSION_DATE
    Date this version of X3DJSAIL was autogenerated: "17 January 2021".
    static java.lang.String WARNING_CONFIGURATION_X3DJSAIL
    Warning message if configuration of X3DJSAIL is incorrect: properties file missing, or other error.
    static java.lang.String WARNING_MESSAGE
    Warning message if model information is unexpected or missing.
    static java.lang.String WARNING_PROTOINSTANCE_NOT_FOUND
    Warning message if a ProtoInstance corresponding to a given ProtoDeclare or ExternProtoDeclare is not found.
    static java.util.ArrayList<java.lang.String> X3DJSAIL_JAR_RELEASE_VERSIONS
    List of officially released X3DJSAIL jar files.X3D
    static java.lang.String XML_ENCODING_DECLARATION_DEFAULT
    Default XML document encoding, used in the XML document declaration appearing in the first line of an XML file.
    static java.lang.String XSLT_ENGINE_NATIVE_JAVA
    XSLT transformation engine: native Java.
    static java.lang.String XSLT_ENGINE_SAXON
    XSLT transformation engine: SAXON (default).

  • Constructor Summary

    Constructors
    Constructor Description
    ConfigurationProperties()  

  • Method Summary

    Modifier and Type Method Description
    static java.lang.String getClassPath()
    Get current system CLASSPATH value.
    static java.lang.String getExiEngine()
    Get preference for XSLT transformation engine to use: EXI_ENGINE_EXIFICIENT or EXI_ENGINE_OPENEXI.
    static java.lang.String getExpectedOutputFileExtension​(java.lang.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 java.lang.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 java.lang.String getXsltEngine()
    Get preference for XSLT transformation engine to use: XSLT_ENGINE_SAXON or XSLT_ENGINE_NATIVE_JAVA.
    static 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 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 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​(java.lang.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 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 void setExiEngine​(java.lang.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​(java.lang.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 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 void setXsltEngine​(java.lang.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

  • Constructor Details

    • ConfigurationProperties

      public ConfigurationProperties()

  • Method Details

    • isStylesheetSupported

      public static boolean isStylesheetSupported​(java.lang.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 java.lang.String getExpectedOutputFileExtension​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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​(java.lang.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 java.lang.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 java.lang.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