Package org.web3d.x3d.jsail.Core
Class meta
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.meta
Functional summary: the meta statement provides metadata information about a scene, where name and content attributes provide attribute=value metadata pairs. This concrete class represents an X3D meta statement.
meta statement tooltip: The meta statement provides metadata information about the X3D model, following the same naming conventions as HTML's meta tag. The name and content attributes together define key=value metadata pairs.
meta statement tooltip: The meta statement provides metadata information about the X3D model, following the same naming conventions as HTML's meta tag. The name and content attributes together define key=value metadata pairs.
- Hint: X3D XML Encoding https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#Header
- Hint: X3D Scene Authoring Hints, meta Statements https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#metaStatements
- Hint: W3C HTML5 Recommendation, 4.2.5 The meta element https://www.w3.org/TR/html5/document-metadata.html#the-meta-element
- Warning: the META statement is capitalized in the X3D Architecture specification and in the X3D ClassicVRML Encoding.
- Hint: X3D Architecture 7.2.5.6 META statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#METAStatement
- Dublin Core Metadata Initiative (DCMI): Terms and Element Set
- HTML5 section 4.2.5: The meta element
- HTML4 section 7.4.4: Meta data
- Dictionary of HTML META Tags (About)
- IETF Best Current Practice (BCP) 47: Tags for Identifying Languages
- ISO 639-2: Codes for the Representation of Names of Languages
- Internet Assigned Numbers Authority (IANA) Protocol Registries: Language Tags
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
String constant COMPONENT defines X3D component for the meta element: Corestatic final String
SFString field named content has default value equal to an empty string.static final String
SFString field named dir has default value equal to an empty string.static final String
Tooltip: left-to-right.static final String
Tooltip: right-to-left.static final String
SFString field named http_equiv has default value equal to an empty string.static final String
SFString field named lang has default value equal to an empty string.static final int
Integer constant LEVEL provides default X3D Core component level for this element: 1static final String
String constant NAME provides name of this element: meta.static final String
Tooltip: permission required to access resource or security status.static final String
Tooltip: name of individual author.static final String
Tooltip: Chemistry Markup Language (CML) version used.static final String
Tooltip: name of individual contributing to this resource.static final String
Tooltip: date of initial version.static final String
Tooltip: name of original author.static final String
SFString field named name has default value equal to an empty string.static final String
Tooltip: summary overview describing this resource.static final String
Tooltip: statement of denial or disavowal regarding potential claims or responsiblity.static final String
Tooltip: name or reference link to a supporting drawing or sketch file.static final String
Tooltip: information about an error (or known problem) that can prevent proper operation.static final String
Tooltip: authoring tool or translation tool.static final String
Tooltip: user hint about resource features or operation.static final String
Tooltip: url address or unique Uniform Resource Identifier (URI) for resource.static final String
Tooltip: name or reference link to supporting image file.static final String
Tooltip: additional info of interest.static final String
Tooltip: additional information of interest.static final String
Tooltip: Related resource of which the described resource is a version, edition, or adaptation.static final String
Tooltip: comma-separated tokens, each of which is a keyword of interest.static final String
Tooltip: content or software license.static final String
Tooltip: entity that mediates access to resource and for whom resource is intended or useful.static final String
Tooltip: date of modified version.static final String
Tooltip: name or reference link to supporting movie file (note that Dublin Core term is MovingImage).static final String
Tooltip: name or reference link to supporting movie.static final String
Tooltip: name or reference link to original file or resource.static final String
Tooltip: name or reference link to supporting photo file (note that Dublin Core term is Image).static final String
Tooltip: name or reference link to supporting photograph file (note that Dublin Core term is Image).static final String
Tooltip: entity responsible for making the resource available.static final String
Tooltip: name or reference link to supporting reference.static final String
Tooltip: prerequisites for operation or viewing.static final String
Tooltip: intellectual property rights (IPR).static final String
Tooltip: search engine and web-spider guidance value: noindex to block page indexing, nofollow to block following links.static final String
Tooltip: name or reference link to supporting sound file.static final String
Tooltip: related resource from which the described resource is derived.static final String
Tooltip: title of relevant specification section.static final String
Tooltip: url for relevant specification section.static final String
Tooltip: search-index subject keywords, key phrases, or classification codes.static final String
Tooltip: resource consisting primarily of words for reading.static final String
Tooltip: file name for this resource.static final String
Tooltip: action item "to do" that still needs to be performed.static final String
Tooltip: date of translation from another format or language.static final String
Tooltip: name of person performing translation from another format or language.static final String
Tooltip: current version number or ID of this resource.static final String
Tooltip: warning information about a known problem that impedes proper operation.static final String
SFString field named scheme has default value equal to an empty string.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.findElementByNameValue
(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.findElementByNameValue
(String nameValue, 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.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.final String
Defines X3D component for the meta element: Corefinal int
Provides default X3D component level for this element: 1Provide String value from inputOutput SFString field named content.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDir()
Provide String enumeration value (baseType xs:NMTOKEN) ["rtl" | "ltr"] from inputOutput SFString field named dir.final String
Provides name of this element: metagetFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide String value from inputOutput SFString field named id.Provide String value from inputOutput SFString field named http-equiv.getLang()
Provide String value from inputOutput SFString field named lang.getName()
Provide String enumeration value (baseType xs:NMTOKEN) ["accessRights" | "author" | "CML-version" | "contributor" | "created" | "creator" | "description" | "disclaimer" | "drawing" | "error" | "generator" | "hint" | "identifier" | "Image" | "info" | "information" | "isVersionOf" | "keywords" | "license" | "mediator" | "modified" | "movie" | "MovingImage" | "original" | "photo" | "photograph" | "publisher" | "reference" | "requires" | "rights" | "robots" | "Sound" | "source" | "specificationSection" | "specificationUrl" | "subject" | "Text" | "title" | "TODO" | "translator" | "translated" | "version" | "warning" | 'etc.'] from inputOutput SFString field named name.Provide String value from inputOutput SFString field named scheme.boolean
hasElementByNameValue
(String nameValue, 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
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.final void
Initialize all member variables to default values.final meta
setContent
(String newValue) Accessor method to assign String value to inputOutput SFString field named content.setContent
(SFString newValue) Assign typed object value to SFString content field, similar tosetContent(String)
.final meta
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final meta
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.Accessor method to assign String enumeration value ("rtl" | "ltr") to inputOutput SFString field named dir.Assign typed object value to SFString dir field, similar tosetDir(String)
.final meta
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.setHttp_equiv
(String newValue) Accessor method to assign String value to inputOutput SFString field named http-equiv.setHttp_equiv
(SFString newValue) Assign typed object value to SFString http_equiv field, similar tosetHttp_equiv(String)
.Accessor method to assign String value to inputOutput SFString field named lang.Assign typed object value to SFString lang field, similar tosetLang(String)
.final meta
Accessor method to assign String enumeration value ("accessRights" | "author" | "CML-version" | "contributor" | "created" | "creator" | "description" | "disclaimer" | "drawing" | "error" | "generator" | "hint" | "identifier" | "Image" | "info" | "information" | "isVersionOf" | "keywords" | "license" | "mediator" | "modified" | "movie" | "MovingImage" | "original" | "photo" | "photograph" | "publisher" | "reference" | "requires" | "rights" | "robots" | "Sound" | "source" | "specificationSection" | "specificationUrl" | "subject" | "Text" | "title" | "TODO" | "translator" | "translated" | "version" | "warning") to inputOutput SFString field named name.Assign typed object value to SFString name field, similar tosetName(String)
.Accessor method to assign String value to inputOutput SFString field named scheme.Assign typed object value to SFString scheme field, similar tosetScheme(String)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteStatement
isNode, isStatement
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
DIR_RTL
Tooltip: right-to-left. SFString field named dir with X3DUOM simpleType metaDirectionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "rtl" (Java syntax) or rtl (XML syntax).- See Also:
-
DIR_LTR
Tooltip: left-to-right. SFString field named dir with X3DUOM simpleType metaDirectionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ltr" (Java syntax) or ltr (XML syntax).- See Also:
-
NAME_ACCESSRIGHTS
Tooltip: permission required to access resource or security status. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "accessRights" (Java syntax) or accessRights (XML syntax).- See Also:
-
NAME_AUTHOR
Tooltip: name of individual author. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "author" (Java syntax) or author (XML syntax).- See Also:
-
NAME_CML_VERSION
Tooltip: Chemistry Markup Language (CML) version used. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "CML-version" (Java syntax) or CML-version (XML syntax).- See Also:
-
NAME_CONTRIBUTOR
Tooltip: name of individual contributing to this resource. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "contributor" (Java syntax) or contributor (XML syntax).- See Also:
-
NAME_CREATED
Tooltip: date of initial version. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "created" (Java syntax) or created (XML syntax).- See Also:
-
NAME_CREATOR
Tooltip: name of original author. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "creator" (Java syntax) or creator (XML syntax).- See Also:
-
NAME_DESCRIPTION
Tooltip: summary overview describing this resource. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "description" (Java syntax) or description (XML syntax).- See Also:
-
NAME_DISCLAIMER
Tooltip: statement of denial or disavowal regarding potential claims or responsiblity. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "disclaimer" (Java syntax) or disclaimer (XML syntax).- See Also:
-
NAME_DRAWING
Tooltip: name or reference link to a supporting drawing or sketch file. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "drawing" (Java syntax) or drawing (XML syntax).- See Also:
-
NAME_ERROR
Tooltip: information about an error (or known problem) that can prevent proper operation. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "error" (Java syntax) or error (XML syntax).- See Also:
-
NAME_GENERATOR
Tooltip: authoring tool or translation tool. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "generator" (Java syntax) or generator (XML syntax).- See Also:
-
NAME_HINT
Tooltip: user hint about resource features or operation. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "hint" (Java syntax) or hint (XML syntax).- See Also:
-
NAME_IDENTIFIER
Tooltip: url address or unique Uniform Resource Identifier (URI) for resource. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "identifier" (Java syntax) or identifier (XML syntax).- See Also:
-
NAME_IMAGE
Tooltip: name or reference link to supporting image file. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "Image" (Java syntax) or Image (XML syntax).- See Also:
-
NAME_INFO
Tooltip: additional info of interest. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "info" (Java syntax) or info (XML syntax).- See Also:
-
NAME_INFORMATION
Tooltip: additional information of interest. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "information" (Java syntax) or information (XML syntax).- See Also:
-
NAME_ISVERSIONOF
Tooltip: Related resource of which the described resource is a version, edition, or adaptation. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "isVersionOf" (Java syntax) or isVersionOf (XML syntax).- See Also:
-
NAME_KEYWORDS
Tooltip: comma-separated tokens, each of which is a keyword of interest. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "keywords" (Java syntax) or keywords (XML syntax).- See Also:
-
NAME_LICENSE
Tooltip: content or software license. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "license" (Java syntax) or license (XML syntax).- See Also:
-
NAME_MEDIATOR
Tooltip: entity that mediates access to resource and for whom resource is intended or useful. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "mediator" (Java syntax) or mediator (XML syntax).- See Also:
-
NAME_MODIFIED
Tooltip: date of modified version. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "modified" (Java syntax) or modified (XML syntax).- See Also:
-
NAME_MOVIE
Tooltip: name or reference link to supporting movie file (note that Dublin Core term is MovingImage). SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "movie" (Java syntax) or movie (XML syntax).- See Also:
-
NAME_MOVINGIMAGE
Tooltip: name or reference link to supporting movie. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "MovingImage" (Java syntax) or MovingImage (XML syntax).- See Also:
-
NAME_ORIGINAL
Tooltip: name or reference link to original file or resource. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "original" (Java syntax) or original (XML syntax).- See Also:
-
NAME_PHOTO
Tooltip: name or reference link to supporting photo file (note that Dublin Core term is Image). SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "photo" (Java syntax) or photo (XML syntax).- See Also:
-
NAME_PHOTOGRAPH
Tooltip: name or reference link to supporting photograph file (note that Dublin Core term is Image). SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "photograph" (Java syntax) or photograph (XML syntax).- See Also:
-
NAME_PUBLISHER
Tooltip: entity responsible for making the resource available. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "publisher" (Java syntax) or publisher (XML syntax).- See Also:
-
NAME_REFERENCE
Tooltip: name or reference link to supporting reference. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "reference" (Java syntax) or reference (XML syntax).- See Also:
-
NAME_REQUIRES
Tooltip: prerequisites for operation or viewing. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "requires" (Java syntax) or requires (XML syntax).- See Also:
-
NAME_RIGHTS
Tooltip: intellectual property rights (IPR). SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "rights" (Java syntax) or rights (XML syntax).- See Also:
-
NAME_ROBOTS
Tooltip: search engine and web-spider guidance value: noindex to block page indexing, nofollow to block following links. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "robots" (Java syntax) or robots (XML syntax).- See Also:
-
NAME_SOUND
Tooltip: name or reference link to supporting sound file. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "Sound" (Java syntax) or Sound (XML syntax).- See Also:
-
NAME_SOURCE
Tooltip: related resource from which the described resource is derived. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "source" (Java syntax) or source (XML syntax).- See Also:
-
NAME_SPECIFICATIONSECTION
Tooltip: title of relevant specification section. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "specificationSection" (Java syntax) or specificationSection (XML syntax).- See Also:
-
NAME_SPECIFICATIONURL
Tooltip: url for relevant specification section. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "specificationUrl" (Java syntax) or specificationUrl (XML syntax).- See Also:
-
NAME_SUBJECT
Tooltip: search-index subject keywords, key phrases, or classification codes. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "subject" (Java syntax) or subject (XML syntax).- See Also:
-
NAME_TEXT
Tooltip: resource consisting primarily of words for reading. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "Text" (Java syntax) or Text (XML syntax).- See Also:
-
NAME_TITLE
Tooltip: file name for this resource. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "title" (Java syntax) or title (XML syntax).- See Also:
-
NAME_TODO
Tooltip: action item "to do" that still needs to be performed. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "TODO" (Java syntax) or TODO (XML syntax).- See Also:
-
NAME_TRANSLATOR
Tooltip: name of person performing translation from another format or language. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "translator" (Java syntax) or translator (XML syntax).- See Also:
-
NAME_TRANSLATED
Tooltip: date of translation from another format or language. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "translated" (Java syntax) or translated (XML syntax).- See Also:
-
NAME_VERSION
Tooltip: current version number or ID of this resource. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "version" (Java syntax) or version (XML syntax).- See Also:
-
NAME_WARNING
Tooltip: warning information about a known problem that impedes proper operation. SFString field named name with X3DUOM simpleType metaNameValues and with X3DUOM baseType xs:NMTOKEN can equal this value "warning" (Java syntax) or warning (XML syntax).- See Also:
-
NAME
-
COMPONENT
String constant COMPONENT defines X3D component for the meta element: Core- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Core component level for this element: 1- See Also:
-
CONTENT_DEFAULT_VALUE
SFString field named content has default value equal to an empty string.- See Also:
-
DIR_DEFAULT_VALUE
SFString field named dir has default value equal to an empty string.- See Also:
-
HTTP_EQUIV_DEFAULT_VALUE
SFString field named http_equiv has default value equal to an empty string.- See Also:
-
LANG_DEFAULT_VALUE
SFString field named lang has default value equal to an empty string.- See Also:
-
NAME_DEFAULT_VALUE
SFString field named name has default value equal to an empty string.- See Also:
-
SCHEME_DEFAULT_VALUE
SFString field named scheme has default value equal to an empty string.- See Also:
-
-
Constructor Details
-
meta
public meta()Constructor for meta to initialize member variables with default values. -
meta
-
-
Method Details
-
getElementName
Provides name of this element: meta- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the meta element: Core- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D statement- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D statement- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteStatement
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Parameters:
newValue
- is new value for the class field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getContent
Provide String value from inputOutput SFString field named content.
Tooltip: The content attribute provides metadata information relevant to the name attribute provided. The name and content attributes together define key=value metadata pairs.- Hint: for broadest searchability, use Dublin Core Metadata Initiative (DCMI) terms for name values. https://www.dublincore.org/documents/dcmi-terms
- Warning: Dublin Core Metadata Initiative (DCMI) requires name to be a token appendable to a URI, so normal expectation for a typical name is type NMTOKEN with no whitespace.
- Hint: alternatively the content attribute can support the http-equiv attribute.
- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Returns:
- value of content field
-
setContent
Accessor method to assign String value to inputOutput SFString field named content.
Tooltip: The content attribute provides metadata information relevant to the name attribute provided. The name and content attributes together define key=value metadata pairs.- Hint: for broadest searchability, use Dublin Core Metadata Initiative (DCMI) terms for name values. https://www.dublincore.org/documents/dcmi-terms
- Warning: Dublin Core Metadata Initiative (DCMI) requires name to be a token appendable to a URI, so normal expectation for a typical name is type NMTOKEN with no whitespace.
- Hint: alternatively the content attribute can support the http-equiv attribute.
- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Parameters:
newValue
- is new value for the content field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setContent
Assign typed object value to SFString content field, similar tosetContent(String)
.- Parameters:
newValue
- is new value for the content field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDir
Provide String enumeration value (baseType xs:NMTOKEN) ["rtl" | "ltr"] from inputOutput SFString field named dir.
Tooltip: Direction for weak/neutral text (ltr=left-to-right, rtl=right-to-left). See <a href="http://www.w3.org/TR/html4/struct/dirlang.html#adef-dir" target="_blank">http://www.w3.org/TR/html4/struct/dirlang.html#adef-dir</a> *
Available enumeration values for string comparison:RTL
,LTR
.- Returns:
- value of dir field
-
setDir
Accessor method to assign String enumeration value ("rtl" | "ltr") to inputOutput SFString field named dir.
Warning: authors can only choose from a strict list of enumeration values (RTL
,LTR
).
Tooltip: Direction for weak/neutral text (ltr=left-to-right, rtl=right-to-left). See <a href="http://www.w3.org/TR/html4/struct/dirlang.html#adef-dir" target="_blank">http://www.w3.org/TR/html4/struct/dirlang.html#adef-dir</a> *- Parameters:
newValue
- is new value for the dir field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setDir
Assign typed object value to SFString dir field, similar tosetDir(String)
.- Parameters:
newValue
- is new value for the dir field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHttp_equiv
Provide String value from inputOutput SFString field named http-equiv.
Tooltip: The http-equiv attribute provides an HTTP header for the value of the content attribute. Example: <meta http-equiv='Expires' content='Tue, 20 Aug 1996 14:25:27 GMT'>.- Hint: the http-equiv attribute can be used to simulate an HTTP response header.
- Warning: if the name attribute is set, the http-equiv attribute should not be set.
- Hint: see http://www.w3.org/TR/html4/struct/global.html#adef-http-equiv
- Returns:
- value of http-equiv field
-
setHttp_equiv
Accessor method to assign String value to inputOutput SFString field named http-equiv.
Tooltip: The http-equiv attribute provides an HTTP header for the value of the content attribute. Example: <meta http-equiv='Expires' content='Tue, 20 Aug 1996 14:25:27 GMT'>.- Hint: the http-equiv attribute can be used to simulate an HTTP response header.
- Warning: if the name attribute is set, the http-equiv attribute should not be set.
- Hint: see http://www.w3.org/TR/html4/struct/global.html#adef-http-equiv
- Parameters:
newValue
- is new value for the http-equiv field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHttp_equiv
Assign typed object value to SFString http_equiv field, similar tosetHttp_equiv(String)
.- Parameters:
newValue
- is new value for the http-equiv field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Parameters:
newValue
- is new value for the id field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getLang
Provide String value from inputOutput SFString field named lang.
Tooltip: Language code, as per [IETF BCP47/RFC5646]. https://www.rfc-editor.org/rfc/bcp/bcp47.txt and described in https://www.w3.org/International/questions/qa-http-and-lang- Hint: Language Subtag Lookup at http://people.w3.org/rishida/utils/subelements
- Returns:
- value of lang field
-
setLang
Accessor method to assign String value to inputOutput SFString field named lang.
Tooltip: Language code, as per [IETF BCP47/RFC5646]. https://www.rfc-editor.org/rfc/bcp/bcp47.txt and described in https://www.w3.org/International/questions/qa-http-and-lang- Hint: Language Subtag Lookup at http://people.w3.org/rishida/utils/subelements
- Parameters:
newValue
- is new value for the lang field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setLang
Assign typed object value to SFString lang field, similar tosetLang(String)
.- Parameters:
newValue
- is new value for the lang field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getName
Provide String enumeration value (baseType xs:NMTOKEN) ["accessRights" | "author" | "CML-version" | "contributor" | "created" | "creator" | "description" | "disclaimer" | "drawing" | "error" | "generator" | "hint" | "identifier" | "Image" | "info" | "information" | "isVersionOf" | "keywords" | "license" | "mediator" | "modified" | "movie" | "MovingImage" | "original" | "photo" | "photograph" | "publisher" | "reference" | "requires" | "rights" | "robots" | "Sound" | "source" | "specificationSection" | "specificationUrl" | "subject" | "Text" | "title" | "TODO" | "translator" | "translated" | "version" | "warning" | 'etc.'] from inputOutput SFString field named name.
Tooltip: Keyword name of the meta attribute, following the same naming conventions as HTML's meta tag.- Hint: for broadest searchability, use Dublin Core Metadata Initiative (DCMI) terms for name values. https://www.dublincore.org/documents/dcmi-terms
- Warning: Dublin Core Metadata Initiative (DCMI) requires name to be a token appendable to a URI, so normal expectation for a typical name is type NMTOKEN with no whitespace.
- Warning: if the name attribute is set, the http-equiv attribute should not be set.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Hint: HTML5 section 4.2.5.1. Standard metadata names https://www.w3.org/TR/html5/document-metadata.html#standard-metadata-names
- Hint: HTML5 section 4.2.5.2. Other metadata names https://www.w3.org/TR/html5/document-metadata.html#other-metadata-names
- Hint: WHATWG Wiki MetaExtensions https://wiki.whatwg.org/wiki/MetaExtensions
- Warning: names are permitted to contain whitespace characters but might be inconsistent. A name value containing whitespace might not validate or match other corresponding values.
Available enumeration values for string comparison:ACCESSRIGHTS
,AUTHOR
,CML_VERSION
,CONTRIBUTOR
,CREATED
,CREATOR
,DESCRIPTION
,DISCLAIMER
,DRAWING
,ERROR
,GENERATOR
,HINT
,IDENTIFIER
,IMAGE
,INFO
,INFORMATION
,ISVERSIONOF
,KEYWORDS
,LICENSE
,MEDIATOR
,MODIFIED
,MOVIE
,MOVINGIMAGE
,ORIGINAL
,PHOTO
,PHOTOGRAPH
,PUBLISHER
,REFERENCE
,REQUIRES
,RIGHTS
,ROBOTS
,SOUND
,SOURCE
,SPECIFICATIONSECTION
,SPECIFICATIONURL
,SUBJECT
,TEXT
,TITLE
,TODO
,TRANSLATOR
,TRANSLATED
,VERSION
,WARNING
.- Returns:
- value of name field
-
setName
Accessor method to assign String enumeration value ("accessRights" | "author" | "CML-version" | "contributor" | "created" | "creator" | "description" | "disclaimer" | "drawing" | "error" | "generator" | "hint" | "identifier" | "Image" | "info" | "information" | "isVersionOf" | "keywords" | "license" | "mediator" | "modified" | "movie" | "MovingImage" | "original" | "photo" | "photograph" | "publisher" | "reference" | "requires" | "rights" | "robots" | "Sound" | "source" | "specificationSection" | "specificationUrl" | "subject" | "Text" | "title" | "TODO" | "translator" | "translated" | "version" | "warning") to inputOutput SFString field named name.
Hint: authors have option to choose from an extendible list of predefined enumeration values (ACCESSRIGHTS
,AUTHOR
,CML_VERSION
,CONTRIBUTOR
,CREATED
,CREATOR
,DESCRIPTION
,DISCLAIMER
,DRAWING
,ERROR
,GENERATOR
,HINT
,IDENTIFIER
,IMAGE
,INFO
,INFORMATION
,ISVERSIONOF
,KEYWORDS
,LICENSE
,MEDIATOR
,MODIFIED
,MOVIE
,MOVINGIMAGE
,ORIGINAL
,PHOTO
,PHOTOGRAPH
,PUBLISHER
,REFERENCE
,REQUIRES
,RIGHTS
,ROBOTS
,SOUND
,SOURCE
,SPECIFICATIONSECTION
,SPECIFICATIONURL
,SUBJECT
,TEXT
,TITLE
,TODO
,TRANSLATOR
,TRANSLATED
,VERSION
,WARNING
).
Tooltip: Keyword name of the meta attribute, following the same naming conventions as HTML's meta tag.- Hint: for broadest searchability, use Dublin Core Metadata Initiative (DCMI) terms for name values. https://www.dublincore.org/documents/dcmi-terms
- Warning: Dublin Core Metadata Initiative (DCMI) requires name to be a token appendable to a URI, so normal expectation for a typical name is type NMTOKEN with no whitespace.
- Warning: if the name attribute is set, the http-equiv attribute should not be set.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Hint: HTML5 section 4.2.5.1. Standard metadata names https://www.w3.org/TR/html5/document-metadata.html#standard-metadata-names
- Hint: HTML5 section 4.2.5.2. Other metadata names https://www.w3.org/TR/html5/document-metadata.html#other-metadata-names
- Hint: WHATWG Wiki MetaExtensions https://wiki.whatwg.org/wiki/MetaExtensions
- Warning: names are permitted to contain whitespace characters but might be inconsistent. A name value containing whitespace might not validate or match other corresponding values.
@see X3D Scene Authoring Hints: Naming Conventions- Parameters:
newValue
- is new value for the name field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setName
Assign typed object value to SFString name field, similar tosetName(String)
.- Parameters:
newValue
- is new value for the name field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getScheme
Provide String value from inputOutput SFString field named scheme.
Tooltip: The scheme attribute allows authors to provide user agents more context for the correct interpretation of meta information. For example, <meta scheme="ISBN" name="identifier" content="0-8230-2355-9"> See <a href="http://www.w3.org/TR/html4/struct/global.html#idx-scheme" target="_blank">http://www.w3.org/TR/html4/struct/global.html#idx-scheme</a> *- Returns:
- value of scheme field
-
setScheme
Accessor method to assign String value to inputOutput SFString field named scheme.
Tooltip: The scheme attribute allows authors to provide user agents more context for the correct interpretation of meta information. For example, <meta scheme="ISBN" name="identifier" content="0-8230-2355-9"> See <a href="http://www.w3.org/TR/html4/struct/global.html#idx-scheme" target="_blank">http://www.w3.org/TR/html4/struct/global.html#idx-scheme</a> *- Parameters:
newValue
- is new value for the scheme field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setScheme
Assign typed object value to SFString scheme field, similar tosetScheme(String)
.- Parameters:
newValue
- is new value for the scheme field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Parameters:
newValue
- is new value for the style field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
meta
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
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. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
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. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
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.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
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.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
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. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-