Class SFString

java.lang.Object

org.web3d.x3d.jsail.fields.X3DConcreteField

org.web3d.x3d.jsail.fields.SFString

All Implemented Interfaces:

SFString, X3DField

public class SFString
extends X3DConcreteField
implements SFString

This utility class provides a concrete implementation corresponding to SFString X3D field type.


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFString defines a single string encoded with the UTF-8 universal character set.

Related field object: MFString

See Also:

• X3D Tooltips: type SFString
• SAI Java Specification: B.4.11 X3DFieldTypes
• SAI Abstract Specification: 5.2.15 SAIFieldType
• X3D Abstract Specification: SFStringAndMFString
• X3D Tooltips
• X3D Tooltips: field
• X3D Tooltips: fieldValue
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_VALUE	Default value for this field type is an empty String.
static final String	DEFAULT_VALUE_STRING	Default string value for this field type is "".
static final String	NAME	String constant NAME provides name of this field type: SFString
static final String	NameCharFilter	XML Regular Expression NameChar.
static final String	NameFilter	XML Regular Expression NameFilter.
static final String	NameStartCharFilter	XML Regular Expression NameStartChar.
static final String	NmtokenFilter	XML Regular Expression Nmtoken.
static final Pattern	PATTERN	Precompiled regular expression (regex) pattern for this field type using default REGEX value.
static final String	REGEX	Default regular expression (regex) pattern for this field type is (\s|\S)*
static final int	TUPLE_SIZE	Default tuple size for this field type is 1 (i.e. number of component values making up a single-field SF object).

Fields inherited from class X3DConcreteField

validationResult

Modifier and Type	Field	Description
protected static StringBuilder	validationResult	Results log of local validation.

Constructor Summary

Constructors

Constructor	Description
SFString()	Constructor for SFString performs value initialization.
SFString(String newValue)	Constructor for SFString using a corresponding Java primitive String as new initial value.
SFString(SFString newValue)	Constructor to copy an SFString value as initial value for this new field object.

Method Summary

Modifier and Type	Method	Description
void	appendValue(String newValue)	Append an additional String to this field.
boolean	equals(String comparisonValue)	Determine whether current SFString object and String contain equal values.
boolean	equals(SFString comparisonSFString)	Determine whether current object and another SFString object contain equal values.
String	getPrimitiveValue()	Provides current value of the field as a Java primitive type.
String	getValue()	Get the current value.
final void	initialize()	Initialization for SFString applies default initial value.
static final boolean	isArray()	Whether or not this field type is an array (false)
boolean	isDefaultValue()	Determine whether current value matches DEFAULT_VALUE
static final boolean	isNMTOKEN(String value)	Utility method to determine if string meets XML NMTOKEN requirements
static boolean	isX3dNodeName(String value)	Case-insensitive test whether or not string is a reserved X3D node name.
static boolean	isX3dStatementName(String value)	Case-insensitive test whether or not string is a reserved X3D statement name.
final boolean	matches()	Test PATTERN match via regular expression (regex) check of current object's toString() value.
static final boolean	matches(String value)	Test PATTERN match with regular expression (regex) of provided value.
static final boolean	meetsX3dInteroperabilityNamingConventions(String value)	Utility method to determine if string meets suggested X3D naming conventions: starts with letter or underscore character, includes letter character numeral or underscore characters.
void	prependValue(String newValue)	Prepend an additional String to this field.
void	setValue(String newValue)	Assign a new value to this field.
SFString	setValue(SFString newValue)	Apply an SFString value to this field.
SFString	setValueByString(String newValue)	Utility accessor for SFString using String value
String	toString()	Provides current value as a String.
static String	toString(String value)	Static utility method to provide String representation of a correctly typed input value.
String	toStringClassicVRML()	Provide String representation of this SFString object, properly escaped using ClassicVRML (.x3dv) or VRML97 (.wrl) syntax.
static String	toStringClassicVRML(String value)	Static utility method to provide SFString representation of input String, properly escaped using ClassicVRML (.x3dv) or VRML97 (.wrl) syntax.
String	toStringX3D()	Provide String representation of this SFString object, properly escaped for XML-based X3D syntax and conforming to X3D Canonical Form.
static String	toStringX3D(String value)	Static utility method to provide String representation of input String, properly escaped using XML-based X3D syntax.
final String	validate()	Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.
final String	validateRegex()	Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.

Methods inherited from class X3DConcreteField

addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritable

Modifier and Type	Method	Description
void	addX3DEventListener(X3DFieldEventListener newListener)	WARNING not tested
X3DConcreteFieldDefinition	getDefinition()	WARNING not implemented
static int	getTupleSize(String fieldType)	Compute tuple size for given type (for example, SFVec3f and MFVec3f have tupleSize of 3).
String	getValidationResult()	Get output of results from prior validation, if any
boolean	isReadable()	Check whether field is readable, default /true/
boolean	isWritable()	Check whether field is writable, default /true/
void	removeX3DEventListener(X3DFieldEventListener oldListener)	WARNING not tested
void	setReadable(boolean newValue)	Set whether field is readable
void	setWritable(boolean newValue)	Set whether field is writable

Methods inherited from class Object

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

Field Details

NAME

public static final String NAME

String constant NAME provides name of this field type: SFString

See Also:

• Constant Field Values

DEFAULT_VALUE

public static final String DEFAULT_VALUE

Default value for this field type is an empty String.

See Also:

• Java Tutorials: Primitive Data Types
• Constant Field Values

DEFAULT_VALUE_STRING

public static final String DEFAULT_VALUE_STRING

Default string value for this field type is "".

See Also:

• Constant Field Values

TUPLE_SIZE

public static final int TUPLE_SIZE

Default tuple size for this field type is 1 (i.e. number of component values making up a single-field SF object).

See Also:

• Constant Field Values

REGEX

public static final String REGEX

Default regular expression (regex) pattern for this field type is (\s|\S)*

See Also:

• PATTERN
• matches()
• matches(String)
• validate()
• X3D Regular Expressions: SFString
• Constant Field Values

PATTERN

public static final Pattern PATTERN

Precompiled regular expression (regex) pattern for this field type using default REGEX value.

See Also:

• REGEX
• matches()
• matches(String)
• validate()
• java.util.regex.Pattern

NameStartCharFilter

public static final String NameStartCharFilter

XML Regular Expression NameStartChar. TODO integrate special-character support into regex. [4] NameStartChar ::= ":" | [A-Z] | "_" | [a-z] | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x2FF] | [#x370-#x37D] | [#x37F-#x1FFF] | [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]

See Also:

• XML 1.1 NameStartChar
• Constant Field Values

NameCharFilter

public static final String NameCharFilter

XML Regular Expression NameChar. TODO integrate special-character support into regex. [4a] NameChar ::= NameStartChar | "-" | "." | [0-9] | #xB7 | [#x0300-#x036F] | [#x203F-#x2040]

See Also:

• XML 1.1 NameChar
• Constant Field Values

NameFilter

public static final String NameFilter

XML Regular Expression NameFilter. TODO integrate special-character support into regex. [5] Name ::= NameStartChar (NameChar)*

See Also:

• XML 1.1 NameFilter
• Constant Field Values

NmtokenFilter

public static final String NmtokenFilter

XML Regular Expression Nmtoken. TODO integrate special-character support into regex. [7] Nmtoken ::= (NameChar)+

See Also:

• XML 1.1 Nmtoken
• Constant Field Values

Constructor Details

SFString

public SFString()

Constructor for SFString performs value initialization.

SFString

public SFString(SFString newValue)

Constructor to copy an SFString value as initial value for this new field object.

Parameters:

newValue - The newValue to apply

SFString

public SFString(String newValue)

Constructor for SFString using a corresponding Java primitive String as new initial value.

Parameters:

newValue - is new value to assign setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)

Method Details

isArray

public static final boolean isArray()

Whether or not this field type is an array (false)

Returns:

true if array type

initialize

public final void initialize()

Initialization for SFString applies default initial value. Static initializer also provided to verify that the regex pattern compiles and matches that default value.

Specified by:

initialize in class X3DConcreteField

See Also:

• Stack Overflow: How to check if a given Regex is valid?
• DEFAULT_VALUE

isNMTOKEN

public static final boolean isNMTOKEN(String value)

Utility method to determine if string meets XML NMTOKEN requirements

Parameters:

value - string to check

Returns:

whether value meets NMTOKEN regex checks

See Also:

• meetsX3dInteroperabilityNamingConventions(String)
• X3D Scene Authoring Hints: Naming Conventions
• X3D Tooltips: type NMTOKEN
• X3D Regular Expressions (regexes)
• XML 1.0 Recommendation, 2.3 Common Syntactic Constructs
• XML 1.1 NMTOKEN
• Java Language Specification: 3 Lexical Structure, 3.2. Lexical Translations
• Java Tutorials: Unicode
• Java and Unicode: Supplementary Characters in the Java Platform

meetsX3dInteroperabilityNamingConventions

public static final boolean meetsX3dInteroperabilityNamingConventions(String value)

Utility method to determine if string meets suggested X3D naming conventions: starts with letter or underscore character, includes letter character numeral or underscore characters. Avoids whitespace, apostrophe, hyphen, minus, comma, period or other special characters in order to ensure portability

Parameters:

value - string to check

Returns:

whether value meets suggested X3D naming requirements

See Also:

• isNMTOKEN(String)
• X3D Scene Authoring Hints: Naming Conventions
• X3D Tooltips: type NMTOKEN
• X3D Regular Expressions (regexes)
• XML 1.0 Recommendation, 2.3 Common Syntactic Constructs
• XML 1.1 NMTOKEN
• Java Language Specification: 3 Lexical Structure, 3.2. Lexical Translations
• Java Tutorials: Unicode
• Java and Unicode: Supplementary Characters in the Java Platform

isX3dNodeName

public static boolean isX3dNodeName(String value)

Case-insensitive test whether or not string is a reserved X3D node name.

Parameters:

value - to check

Returns:

whether value is a reserved X3D node name

isX3dStatementName

public static boolean isX3dStatementName(String value)

Case-insensitive test whether or not string is a reserved X3D statement name.

Parameters:

value - to check

Returns:

whether value is a reserved X3D node name

appendValue

public void appendValue(String newValue)

Append an additional String to this field.

Parameters:

newValue - The value to append.

See Also:

• String.concat(String)
• prependValue(String)

prependValue

public void prependValue(String newValue)

Prepend an additional String to this field.

Parameters:

newValue - The value to prepend.

See Also:

• appendValue(String)

equals

public boolean equals(SFString comparisonSFString)

Determine whether current object and another SFString object contain equal values.

Parameters:

comparisonSFString - field type to compare

Returns:

true if equivalent, false otherwise

equals

public boolean equals(String comparisonValue)

Determine whether current SFString object and String contain equal values.

Parameters:

comparisonValue - String[] array to compare

Returns:

true if equivalent, false otherwise

validate

public final String validate()

Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.

Returns:

empty string if PATTERN matches, warning otherwise

See Also:

• java.util.regex.Pattern
• validate()
• validateRegex()

validateRegex

public final String validateRegex()

Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.

Returns:

empty string if PATTERN matches, warning otherwise

See Also:

• REGEX
• PATTERN
• matches()
• matches(String)
• validate()
• validate()
• java.util.regex.Pattern

matches

public final boolean matches()

Test PATTERN match via regular expression (regex) check of current object's toString() value.

Returns:

true if PATTERN matches, false otherwise

See Also:

• REGEX
• PATTERN
• matches()
• matches(String)
• validate()
• java.util.regex.Pattern

matches

public static final boolean matches(String value)

Test PATTERN match with regular expression (regex) of provided value.

Parameters:

value - String to check against regex pattern for successful match

Returns:

true if PATTERN matches, false otherwise

See Also:

• REGEX
• PATTERN
• matches()
• matches(String)
• validate()
• java.util.regex.Pattern

setValueByString

public SFString setValueByString(String newValue)
                          throws InvalidFieldValueException

Utility accessor for SFString using String value

Parameters:

newValue - is new value to assign

Returns:

MFMatrix4d - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).

Throws:

InvalidFieldValueException

toString

public static String toString(String value)

Static utility method to provide String representation of a correctly typed input value.

Parameters:

value - The value to convert to a String

Returns:

XML/X3D-escaped String version of the provided value

See Also:

• X3D Tooltips: type
• toStringX3D(String)
• MFString.toStringX3D()
• X3D Abstract Specification: 5.3.14 SFString and MFString
• X3D XML Encoding: 5.15 SFString and MFString
• X3D Tooltips: Text
• X3D Tooltips: type

toStringX3D

public static String toStringX3D(String value)

Static utility method to provide String representation of input String, properly escaped using XML-based X3D syntax.

Parameters:

value - The value to convert to an escaped String

Returns:

XML/X3D-escaped String version of the provided value

See Also:

• MFString.toStringX3D()
• toStringClassicVRML(String)
• MFString.toStringClassicVRML()
• X3D Abstract Specification: 5.3.14 SFString and MFString
• X3D XML Encoding: 5.15 SFString and MFString
• X3D Tooltips: Text
• X3D Tooltips: type
• X3D Tooltips: SFString

toStringClassicVRML

public static String toStringClassicVRML(String value)

Static utility method to provide SFString representation of input String, properly escaped using ClassicVRML (.x3dv) or VRML97 (.wrl) syntax.

Parameters:

value - The value to convert to an escaped String

Returns:

ClassicVRML/VRML97-escaped String version of the provided value

See Also:

• toStringX3D(String)
• MFString.toStringX3D()
• MFString.toStringClassicVRML()
• X3D Abstract Specification: 5.3.14 SFString and MFString
• X3D ClassicVRML Encoding: 5.15 SFString and MFString
• X3D Tooltips: Text
• X3D Tooltips: type
• X3D Tooltips: SFString

toStringX3D

public String toStringX3D()

Provide String representation of this SFString object, properly escaped for XML-based X3D syntax and conforming to X3D Canonical Form.

Returns:

XML/X3D-escaped version of this SFString

See Also:

• toStringX3D(String)
• MFString.toStringX3D()
• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D Tooltips: type SFString
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML()

Provide String representation of this SFString object, properly escaped using ClassicVRML (.x3dv) or VRML97 (.wrl) syntax.

Returns:

ClassicVRML/VRML97-escaped version of this SFString

See Also:

• toStringClassicVRML(String)
• MFString.toStringClassicVRML()
• X3D.FILE_EXTENSION_CLASSICVRML
• X3D.FILE_EXTENSION_VRML97
• X3D Abstract Specification: 5.3.14 SFString and MFString
• X3D ClassicVRML Encoding: 5.15 SFString and MFString
• X3D Tooltips: Text
• X3D Tooltips: type
• X3D Tooltips: SFString

getValue

public String getValue()

Get the current value.

Specified by:

getValue in interface SFString

Returns:

current value

getPrimitiveValue

public String getPrimitiveValue()

Provides current value of the field as a Java primitive type.

Returns:

current value

toString

public String toString()

Provides current value as a String.

Overrides:

toString in class Object

Returns:

String version of the provided value

See Also:

• X3D Tooltips: type SFString

setValue

public void setValue(String newValue)

Assign a new value to this field.

Specified by:

setValue in interface SFString

Parameters:

newValue - The replacement value to assign.

See Also:

• X3DConcreteField.getTupleSize(String)

setValue

public SFString setValue(SFString newValue)

Apply an SFString value to this field.

Parameters:

newValue - The newValue to apply

Returns:

SFString - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

isDefaultValue

public boolean isDefaultValue()

Determine whether current value matches DEFAULT_VALUE

Returns:

whether current value matches DEFAULT_VALUE

See Also:

• DEFAULT_VALUE