Package org.web3d.x3d.jsail.fields

Class MFNode

java.lang.Object

org.web3d.x3d.jsail.fields.X3DConcreteField

org.web3d.x3d.jsail.fields.MFNode

All Implemented Interfaces:

MField, MFNode, X3DField

public class MFNode
extends X3DConcreteField
implements MFNode

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

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes.
Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). MFNode specifies zero or more nodes; the default value of an MFNode field is the empty list.

Related field object: SFNode

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final X3DNode[]	DEFAULT_VALUE	Default value for this field type is an empty array.
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 element: MFNode
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 org.web3d.x3d.jsail.fields.X3DConcreteField

validationResult

Constructor Summary

Constructors

Constructor	Description
MFNode()	Constructor for MFNode performs value initialization.
MFNode(MFNode newValue)	Constructor to copy an MFNode value as initial value for this new field object.
MFNode(SFNode newValue)	Utility constructor for MFNode using a corresponding SFNode as new initial value (which must pass parsing validation checks).
MFNode(X3DNode newValue)	Utility constructor for MFNode to assign a single org.web3d.x3d.sai.Core.X3DNode as new initial array value.
MFNode(X3DNode[] newValue)	Constructor for MFNode using a corresponding Java primitive org.web3d.x3d.sai.Core.X3DNode[] array as new initial value.

Method Summary

Modifier and Type	Method	Description
MFNode	append(MFNode newValue)	Appends a new MFNode to the end of the existing value array, increasing the field length accordingly.
MFNode	append(SFNode newValue)	Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly.
void	append(X3DNode newValue)	Places new value(s) at the end of the existing value array, increasing the field length accordingly.
void	append(X3DNode[] newValue)	Appends another array at the end of the existing value array, increasing the field length accordingly.
void	clear()	Removes all values in the field array, changing the array size to zero.
MFNode	clearChildren()	Utility method to clear all contained children including nodes, statements and comments (if any).
X3DNode	get1Value(int index)	Get an individual value from the existing field array.
X3DNode[]	getPrimitiveValue()	Provides current value of the field as a Java primitive type.
void	getValue(X3DNode[] valueDestination)	Get the current value of this MFNode by copying it into the valueDestination array, leaving the current object unchanged.
final void	initialize()	Initialization for MFNode applies default initial value.
void	insertValue(int index, X3DNode newValue)	Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
static final boolean	isArray()	Whether or not this field type is an array (true)
boolean	isDefaultValue()	Determine whether current value matches DEFAULT_VALUE
void	remove(int index)	Remove one SFNode element of the field array at index position, if found.
void	set1Value(int index, X3DNode newValue)	Replace a single value at the appropriate location in the existing value array.
void	setValue(int size, X3DNode[] newValue)	Assign an array subset to this field.
MFNode	setValue(MFNode newValue)	Apply an MFNode value to this field.
MFNode	setValue(SFNode newValue)	Assign a single-field SFNode as new array value.
void	setValue(X3DNode[] newValue)	Assign a new org.web3d.x3d.sai.Core.X3DNode[] value to this field.
int	size()	Get the size of the underlying data array, meaning the number of simple SFNode elements for the given data type.
String	toString()	Provides current value as a String.
static String	toString(X3DNode[] value)	Static utility method to provide String representation of a correctly typed input value.

Methods inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField

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

Methods inherited from class java.lang.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 element: MFNode

See Also:

• Constant Field Values

DEFAULT_VALUE

public static final X3DNode[] DEFAULT_VALUE

Default value for this field type is an empty array.

See Also:

• Java Tutorials: Primitive Data Types

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

Constructor Details

MFNode

public MFNode()

Constructor for MFNode performs value initialization.

MFNode

public MFNode(X3DNode newValue)

Utility constructor for MFNode to assign a single org.web3d.x3d.sai.Core.X3DNode as new initial array value.

Parameters:

newValue - is new value to assign

MFNode

public MFNode(SFNode newValue)

Utility constructor for MFNode using a corresponding SFNode as new initial value (which must pass parsing validation checks).

Parameters:

newValue - is new value to assign

MFNode

public MFNode(MFNode newValue)

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

Parameters:

newValue - The newValue to apply

MFNode

public MFNode(X3DNode[] newValue)

Constructor for MFNode using a corresponding Java primitive org.web3d.x3d.sai.Core.X3DNode[] array 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 (true)

Returns:

true if array type

initialize

public final void initialize()

Initialization for MFNode applies default initial value.

Specified by:

initialize in class X3DConcreteField

See Also:

• DEFAULT_VALUE

toString

public static String toString(X3DNode[] value)

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

Parameters:

value - The value to convert to a String

Returns:

String version of the provided value

See Also:

• X3D Tooltips: type

getValue

public void getValue(X3DNode[] valueDestination)

Get the current value of this MFNode by copying it into the valueDestination array, leaving the current object unchanged.

Specified by:

getValue in interface MFNode

Parameters:

valueDestination - The array to be filled in with current field values.

getPrimitiveValue

public X3DNode[] 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 MFNode

get1Value

public X3DNode get1Value(int index)

Get an individual value from the existing field array.

If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.

Specified by:

get1Value in interface MFNode

Parameters:

index - is position of selected value in current array

Returns:

The selected value

Throws:

ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.

setValue

public void setValue(int size,
 X3DNode[] newValue)

Assign an array subset to this field.

Specified by:

setValue in interface MFNode

Parameters:

size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.

newValue - The replacement value array to (potentially) slice and then assign.

See Also:

• X3DConcreteField.getTupleSize(String)

setValue

public void setValue(X3DNode[] newValue)

Assign a new org.web3d.x3d.sai.Core.X3DNode[] value to this field.

Parameters:

newValue - is replacement value array to assign

See Also:

• X3DConcreteField.getTupleSize(String)

setValue

public MFNode setValue(SFNode newValue)

Assign a single-field SFNode as new array value.

Parameters:

newValue - The replacement value to assign.

Returns:

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

set1Value

public void set1Value(int index,
 X3DNode newValue)
               throws ArrayIndexOutOfBoundsException

Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change.

Specified by:

set1Value in interface MFNode

Parameters:

index - is position of selected value in current array

newValue - provides new value to apply

Throws:

ArrayIndexOutOfBoundsException

See Also:

• X3DConcreteField.getTupleSize(String)

append

public void append(X3DNode newValue)

Places new value(s) at the end of the existing value array, increasing the field length accordingly.

Specified by:

append in interface MFNode

Parameters:

newValue - The newValue to append

See Also:

• X3DConcreteField.getTupleSize(String)

append

public void append(X3DNode[] newValue)

Appends another array at the end of the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec4f tuple size of 4.

Parameters:

newValue - The newValue to append

See Also:

• X3DConcreteField.getTupleSize(String)

append

public MFNode append(SFNode newValue)

Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for incrementally constructing arrays.

Parameters:

newValue - The newValue to append

Returns:

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

append

public MFNode append(MFNode newValue)

Appends a new MFNode to the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for constructing long arrays.

Parameters:

newValue - The newValue to append

Returns:

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

See Also:

• X3DConcreteField.getTupleSize(String)

insertValue

public void insertValue(int index,
 X3DNode newValue)

Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.

Specified by:

insertValue in interface MFNode

Parameters:

index - The position for the inserted value in the current array

newValue - The newValue to insert

See Also:

• X3DConcreteField.getTupleSize(String)

size

public int size()

Get the size of the underlying data array, meaning the number of simple SFNode elements for the given data type.

Specified by:

size in interface MField

Returns:

The number of SFNode elements in this field array.

clear

public void clear()

Removes all values in the field array, changing the array size to zero.

Specified by:

clear in interface MField

remove

public void remove(int index)

Remove one SFNode element of the field array at index position, if found. Initial element is at index 0.

Specified by:

remove in interface MField

Parameters:

index - position of element in field array that gets removed

setValue

public MFNode setValue(MFNode newValue)

Apply an MFNode value to this field.

Parameters:

newValue - The newValue to apply

Returns:

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

clearChildren

public MFNode clearChildren()

Utility method to clear all contained children including nodes, statements and comments (if any).

Returns:

MFNode - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

isDefaultValue

public boolean isDefaultValue()

Determine whether current value matches DEFAULT_VALUE

Returns:

whether current value matches DEFAULT_VALUE

See Also:

• DEFAULT_VALUE