public class headObject extends X3DConcreteStatement
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT
String constant COMPONENT defines X3D component for the head element: Core
|
static int |
LEVEL
Integer constant LEVEL provides default X3D Core component level for this element: 1
|
static java.lang.String |
NAME
String constant NAME provides name of this element: head.
|
validationResult| Constructor and Description |
|---|
headObject()
Constructor for headObject to initialize member variables with default values.
|
| Modifier and Type | Method and Description |
|---|---|
headObject |
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.
|
headObject |
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.
|
headObject |
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.
|
headObject |
addComponent(componentObject newValue)
Add array of child component nodes to array of existing nodes (if any).
|
headObject |
addMeta(metaObject newValue)
Add array of child meta nodes to array of existing nodes (if any).
|
headObject |
addUnit(unitObject newValue)
Add array of child unit nodes to array of existing nodes (if any).
|
headObject |
clearComponent()
Utility method to clear MFNode value of componentList field.
|
headObject |
clearMeta()
Utility method to clear MFNode value of metaList field.
|
headObject |
clearUnit()
Utility method to clear MFNode value of unitList field.
|
componentObject |
findComponentByName(java.lang.String componentName)
Find contained component statement by name, if present.
|
X3DConcreteElement |
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
|
X3DConcreteElement |
findElementByNameValue(java.lang.String nameValue,
java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
|
metaObject |
findMetaByName(java.lang.String metaName)
Find contained meta statement by name, if present.
|
X3DConcreteNode |
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
|
unitObject |
findUnitByName(java.lang.String unitName)
Find contained unit statement by name, if present.
|
java.lang.String |
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.
|
java.lang.String |
getComponent()
Defines X3D component for the head element: Core
|
int |
getComponentLevel()
Provides default X3D component level for this element: 1
|
java.util.ArrayList<componentObject> |
getComponentList()
Provide array of componentObject results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field component.
|
java.lang.String |
getElementName()
Provides name of this element: head
|
java.lang.String |
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.
|
java.util.ArrayList<metaObject> |
getMetaList()
Provide array of metaObject results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field meta.
|
java.util.ArrayList<unitObject> |
getUnitList()
Provide array of unitObject results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field unit.
|
boolean |
hasComponent()
Indicate whether an object is available for inputOutput MFNode field componentList.
|
boolean |
hasElementByNameValue(java.lang.String nameValue,
java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
|
boolean |
hasMeta()
Indicate whether an object is available for inputOutput MFNode field metaList.
|
boolean |
hasNodeByDEF(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
|
boolean |
hasUnit()
Indicate whether an object is available for inputOutput MFNode field unitList.
|
void |
initialize()
Initialize all member variables to default values.
|
headObject |
setComponent(componentObject newValue)
Set single child component node, replacing prior array of existing nodes (if any).
|
headObject |
setComponentList(java.util.ArrayList<componentObject> newValue)
Assign componentObject array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field component.
|
headObject |
setMeta(metaObject newValue)
Set single child meta node, replacing prior array of existing nodes (if any).
|
headObject |
setMetaList(java.util.ArrayList<metaObject> newValue)
Assign metaObject array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field meta.
|
headObject |
setUnit(unitObject newValue)
Set single child unit node, replacing prior array of existing nodes (if any).
|
headObject |
setUnitList(java.util.ArrayList<unitObject> newValue)
Assign unitObject array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field unit.
|
java.lang.String |
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.
|
java.lang.String |
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.
|
java.lang.String |
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
|
java.lang.String |
validate()
Recursive method to validate this element plus all contained nodes and statements,
using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
|
isNode, isStatementclearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3Dpublic static final java.lang.String NAME
public static final java.lang.String COMPONENT
public static final int LEVEL
public headObject()
public final java.lang.String getElementName()
getElementName in class X3DConcreteElementpublic final java.lang.String getComponent()
getComponent in class X3DConcreteElementpublic final int getComponentLevel()
getComponentLevel in class X3DConcreteElementpublic java.lang.String getFieldType(java.lang.String fieldName)
getFieldType in class X3DConcreteElementfieldName - name of field in this X3D statementConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPEpublic java.lang.String getAccessType(java.lang.String fieldName)
getAccessType in class X3DConcreteElementfieldName - name of field in this X3D statementConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPEpublic final void initialize()
initialize in class X3DConcreteStatementpublic java.util.ArrayList<componentObject> getComponentList()
componentObjectpublic headObject setComponentList(java.util.ArrayList<componentObject> newValue)
newValue - is new value for the component field.headObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public headObject addComponent(componentObject newValue)
newValue - is new value array to be appended the component field.headObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public headObject setComponent(componentObject newValue)
newValue - is new node for the component field (restricted to component)headObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public headObject clearComponent()
headObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public boolean hasComponent()
getComponentList()public java.util.ArrayList<metaObject> getMetaList()
metaObjectpublic headObject setMetaList(java.util.ArrayList<metaObject> newValue)
newValue - is new value for the meta field.headObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public headObject addMeta(metaObject newValue)
newValue - is new value array to be appended the meta field.headObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public headObject setMeta(metaObject newValue)
newValue - is new node for the meta field (restricted to meta)headObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public headObject clearMeta()
headObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public boolean hasMeta()
getMetaList()public java.util.ArrayList<unitObject> getUnitList()
unitObjectpublic headObject setUnitList(java.util.ArrayList<unitObject> newValue)
newValue - is new value for the unit field.headObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public headObject addUnit(unitObject newValue)
newValue - is new value array to be appended the unit field.headObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public headObject setUnit(unitObject newValue)
newValue - is new node for the unit field (restricted to unit)headObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public headObject clearUnit()
headObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public boolean hasUnit()
getUnitList()public headObject addComments(java.lang.String newComment)
addComments in class X3DConcreteElementnewComment - initial valueheadObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public headObject addComments(java.lang.String[] newComments)
addComments in class X3DConcreteElementnewComments - array of commentsheadObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public headObject addComments(CommentsBlock newCommentsBlock)
addComments in class X3DConcreteElementnewCommentsBlock - block of comments to addheadObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public java.lang.String toStringX3D(int indentLevel)
toStringX3D in class X3DConcreteElementindentLevel - number of levels of indentation for this elementX3DObject.FILE_EXTENSION_X3D,
X3DObject.FILE_EXTENSION_XML,
X3DObject.toStringXML(),
X3DObject.toFileXML(String),
X3DObject.toFileX3D(String),
X3D XML Encoding,
X3D Compressed Binary Encoding: X3D Canonical Formpublic java.lang.String toStringClassicVRML(int indentLevel)
toStringClassicVRML in class X3DConcreteElementindentLevel - number of levels of indentation for this elementX3DObject.FILE_EXTENSION_CLASSICVRML,
X3D Resources: Virtual Reality Modeling Language (VRML) 97,
Extensible 3D (X3D) encodings Part 2: Classic VRML encoding,
Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammarpublic java.lang.String toStringVRML97(int indentLevel)
toStringVRML97 in class X3DConcreteElementindentLevel - number of levels of indentation for this elementX3DObject.FILE_EXTENSION_VRML97,
X3D Resources: Virtual Reality Modeling Language (VRML) 97,
Virtual Reality Modeling Language (VRML) 97 specification,
VRML 97 v2.1 Amendmentpublic X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
findElementByNameValue in class X3DConcreteElementnameValue - is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
findElementByNameValue in class X3DConcreteElementnameValue - is value of the name field being searched for in this element and child elements(if any)elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)findNodeByDEF(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public boolean hasElementByNameValue(java.lang.String nameValue,
java.lang.String elementName)
nameValue - is value of the name field being searched for in this element and child elements(if any)elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)findElementByNameValue(String, String)public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
findNodeByDEF in class X3DConcreteElementDEFvalue - is value of the name field being searched for in this element and child elements(if any)findElementByNameValue(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public boolean hasNodeByDEF(java.lang.String DEFvalue)
DEFvalue - is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String)public java.lang.String validate()
validate in class X3DConcreteElementpublic metaObject findMetaByName(java.lang.String metaName)
metaName - is name attribute for meta element of interestpublic componentObject findComponentByName(java.lang.String componentName)
componentName - is name attribute for component element of interestpublic unitObject findUnitByName(java.lang.String unitName)
unitName - is name attribute for unit element of interestCopyright ©2005-2017 Web3D Consortium under an open-source license, free for any use. Feedback is welcome.