Package org.web3d.parser.x3d

Class X3DFieldParser

java.lang.Object

org.web3d.parser.x3d.X3DFieldParser

All Implemented Interfaces:

X3DFieldParserConstants

public class X3DFieldParser
extends Object
implements X3DFieldParserConstants

A parser class for raw field values to turn them into Java primitive types suitable for dealing with X3D field types.

The parser assumes that we have a raw field value that does not contain any surrounding values. For example, it expects MFField values to be stripped of surrounding brackets before being passed to these methods.

There are two ways of using this class: parsing a know field type, and parsing an unknown field type and getting the parser to return the appropriate (closest guess) value to you.

This parser has been continually evolving since first written for the VRML97 open source effort. The original contributor was Rick Goldberg of Sun Microsystems. Since then it has been through numerous tweaks and re-writes

The assumption of this parser is that each time you call the method it will have a non-zero length, non-empty string. There should be at least one non-whitespace character in the string. If not, a parse exception will be raised. You can see what JavaCC thinks the grammar is here

Version:

Grammar $Revision: 1.12 $

Author:

Justin Couch, Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
Token	jj_nt	Next token.
Token	token	Current token.
X3DFieldParserTokenManager	token_source	Generated Token Manager.

Fields inherited from interface org.web3d.parser.x3d.X3DFieldParserConstants

COMMENT, DEFAULT, EOF, FALSE, FALSE_L, LBRACKET, NUMBER_LITERAL, RBRACKET, STRING_LITERAL, tokenImage, TRUE, TRUE_L

Constructor Summary

Constructors

Constructor	Description
X3DFieldParser(InputStream stream)	Constructor with InputStream.
X3DFieldParser(InputStream stream, String encoding)	Constructor with InputStream and supplied encoding
X3DFieldParser(Reader stream)	Constructor.
X3DFieldParser(X3DFieldParserTokenManager tm)	Constructor with generated Token Manager.

Method Summary

Modifier and Type	Method	Description
final void	disable_tracing()	Disable tracing.
final void	enable_tracing()	Enable tracing.
ParseException	generateParseException()	Generate ParseException.
DocumentLocator	getDocumentLocator()	Fetch the documentLocator used by this parser.
final Token	getNextToken()	Get the next Token.
final Token	getToken(int index)	Get the specific Token.
final boolean[]	MFBool()	Parse an MFBool value.
final boolean[]	MFBoolLower()	Parse an MFBool that is in lower case for XML parsing.
final float[]	MFColor()	Parse an MFColor value.
final float[]	MFColorRGBA()	Parse an MFColorRGBA value.
final double[]	MFDouble()	Parse an MFDouble value.
final float[]	MFFloat()	Parse an MFFloat value.
final int[]	MFImage()	Parse an MFImage value.
final int[]	MFInt32()	Parse an MFInt32 value.
final long[]	MFLong()	Parse an MFLong value.
final double[]	MFMatrix3d()	Parse an MFMatrix3d value.
final float[]	MFMatrix3f()	Parse an MFMatrix3f value.
final double[]	MFMatrix4d()	Parse an MFMatrix4d value.
final float[]	MFMatrix4f()	Parse an MFMatrix4f value.
final float[]	MFRotation()	Parse an MFRotation value.
final String[]	MFString()	Parse an MFString value.
final double[]	MFTime()	Parse an MFTime value.
final double[]	MFVec2d()	Parse an MFVec2d value.
final float[]	MFVec2f()	Parse an MFVec2f value.
final double[]	MFVec3d()	Parse an MFVec3d value.
final float[]	MFVec3f()	Parse an MFVec3f value.
final double[]	MFVec4d()	Parse an MFVec4d value.
final float[]	MFVec4f()	Parse an MFVec4f value.
final Object	parseUnknownField(boolean useInt)	This does not use the other methods to do the field parsing.
void	ReInit(InputStream stream)	Reinitialise.
void	ReInit(InputStream stream, String encoding)	Reinitialise.
void	ReInit(Reader stream)	Reinitialise.
void	ReInit(X3DFieldParserTokenManager tm)	Reinitialise.
final boolean	SFBool()	Parse an SFBool value.
final boolean	SFBoolLower()	Parse an SFBool value using lower case lettering, for XML field values.
final float[]	SFColor()	Parse an SFColor value.
final float[]	SFColorRGBA()	Parse an SFColorRGBA value.
final double	SFDouble()	Parse an SFDouble value.
final float	SFFloat()	Parse an SFFloat value.
final int[]	SFImage()	Parse an SFImage value.
final int	SFInt32()	Parse an SFInt value.
final long	SFLong()	Parse an SFLong value.
final double[]	SFMatrix3d()	Parse an SFMatrix3d value.
final float[]	SFMatrix3f()	Parse an SFMatrix3f value.
final double[]	SFMatrix4d()	Parse an SFMatrix4d value.
final float[]	SFMatrix4f()	Parse an SFMatrix4f value.
final float[]	SFRotation()	Parse an SFRotation value.
final String	SFString()	Parse an SFString value.
final double	SFTime()	Parse an SFTime value.
final double[]	SFVec2d()	Parse an SFVec2d value.
final float[]	SFVec2f()	Parse an SFVec2f value.
final double[]	SFVec3d()	Parse an SFVec3d value.
final float[]	SFVec3f()	Parse an SFVec3f value.
final double[]	SFVec4d()	Parse an SFVec4d value.
final float[]	SFVec4f()	Parse an SFVec4f value.

Methods inherited from class java.lang.Object

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

Field Details

token_source

public X3DFieldParserTokenManager token_source

Generated Token Manager.

token

public Token token

Current token.

jj_nt

public Token jj_nt

Next token.

Constructor Details

X3DFieldParser

public X3DFieldParser(InputStream stream)

Constructor with InputStream.

X3DFieldParser

public X3DFieldParser(InputStream stream,
 String encoding)

Constructor with InputStream and supplied encoding

X3DFieldParser

public X3DFieldParser(Reader stream)

Constructor.

X3DFieldParser

public X3DFieldParser(X3DFieldParserTokenManager tm)

Constructor with generated Token Manager.

Method Details

getDocumentLocator

public DocumentLocator getDocumentLocator()

Fetch the documentLocator used by this parser. This is here so that the user of this parser can ask for it and set it before calling startDocument(). Once the scene has started parsing in this class it is too late for the documentLocator to be set. This parser does set it internally when asked for a X3DRelaxedParser.Scene() but there may be other times when it is not set.

Returns:

The documentLocator used for syntax errors

parseUnknownField

public final Object parseUnknownField(boolean useInt)
                               throws ParseException

This does not use the other methods to do the field parsing. Instead, it goes on the raw values that are presented and returns objects to represent that. We look for either single values or multiple values. For any of these we return a representative object. The return value could be one of these:

• Boolean
• Integer
• Long
• Float
• String
• boolean[]
• int[]
• long[]
• float[]
• String[]

Parameters:

useInt - A hint to use if this is a number field we are parsing to decide whether to parse number strings as an int or float for type checking. If expecting any other sort of field, has no effect.

Throws:

ParseException

SFInt32

public final int SFInt32()
                  throws ParseException

Parse an SFInt value. If there is more than one int value in the string it will be ignored.

Throws:

ParseException

MFInt32

public final int[] MFInt32()
                    throws ParseException

Parse an MFInt32 value.

 MFInt32 ::=
   "[" NUMBER_LITERAL* "]" |
   NUMBER_LITERAL*
 

Throws:

ParseException

SFLong

public final long SFLong()
                  throws ParseException

Parse an SFLong value. If there is more than one long value in the string it will be ignored.

Throws:

ParseException

MFLong

public final long[] MFLong()
                    throws ParseException

Parse an MFLong value.

 MFLong ::=
   "[" NUMBER_LITERAL* "]" |
   NUMBER_LITERAL*
 

Throws:

ParseException

SFFloat

public final float SFFloat()
                    throws ParseException

Parse an SFFloat value. If there is more than one float value in the string it will be ignored.

Throws:

ParseException

MFFloat

public final float[] MFFloat()
                      throws ParseException

Parse an MFFloat value.

 MFFloat ::=
   "[" NUMBER_LITERAL* "]" |
   NUMBER_LITERAL*
 

Throws:

ParseException

SFDouble

public final double SFDouble()
                      throws ParseException

Parse an SFDouble value. If there is more than one double value in the string it will be ignored.

Throws:

ParseException

MFDouble

public final double[] MFDouble()
                        throws ParseException

Parse an MFDouble value.

 MFDouble ::=
   "[" NUMBER_LITERAL* "]" |
   NUMBER_LITERAL*
 

Throws:

ParseException

SFBool

public final boolean SFBool()
                     throws ParseException

Parse an SFBool value. If there is more than one boolean value in the string it will be ignored.

Throws:

ParseException

SFBoolLower

public final boolean SFBoolLower()
                          throws ParseException

Parse an SFBool value using lower case lettering, for XML field values. If there is more than one boolean value in the string it will be ignored.

Throws:

ParseException

MFBool

public final boolean[] MFBool()
                       throws ParseException

Parse an MFBool value.

 MFBool ::=
   "[" ("TRUE" | "FALSE")* "]" |
   ("TRUE" | "FALSE")*
 

Throws:

ParseException

MFBoolLower

public final boolean[] MFBoolLower()
                            throws ParseException

Parse an MFBool that is in lower case for XML parsing.

 MFBool ::=
   "[" ("true" | "false")* "]" |
   ("true" | "false")*
 

Throws:

ParseException

SFString

public final String SFString()
                      throws ParseException

Parse an SFString value. We really shouldn't need this, but it is here for completeness.

Throws:

ParseException

MFString

public final String[] MFString()
                        throws ParseException

Parse an MFString value.

 MFString ::=
   "[" ( STRING_LITERAL)* "]" |
   (STRING_LITERAL)*
 

Throws:

ParseException

SFVec2f

public final float[] SFVec2f()
                      throws ParseException

Parse an SFVec2f value. If there is more than one float value in the string it will be ignored.

Throws:

ParseException

MFVec2f

public final float[] MFVec2f()
                      throws ParseException

Parse an MFVec2f value.

 MFVec2f ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFVec3f

public final float[] SFVec3f()
                      throws ParseException

Parse an SFVec3f value. If there is more than one float value in the string it will be ignored.

Throws:

ParseException

MFVec3f

public final float[] MFVec3f()
                      throws ParseException

Parse an MFVec3f value.

 MFVec3f ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFVec2d

public final double[] SFVec2d()
                       throws ParseException

Parse an SFVec2d value. If there is more than one double value in the string it will be ignored.

Throws:

ParseException

MFVec2d

public final double[] MFVec2d()
                       throws ParseException

Parse an MFVec2d value.

 MFVec2d ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFVec3d

public final double[] SFVec3d()
                       throws ParseException

Parse an SFVec3d value. If there is more than one double value in the string it will be ignored.

Throws:

ParseException

MFVec3d

public final double[] MFVec3d()
                       throws ParseException

Parse an MFVec3d value.

 MFVec3d ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFVec4f

public final float[] SFVec4f()
                      throws ParseException

Parse an SFVec4f value. If there is more than one float value in the string it will be ignored.

Throws:

ParseException

MFVec4f

public final float[] MFVec4f()
                      throws ParseException

Parse an MFVec4f value.

 MFVec4f ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFVec4d

public final double[] SFVec4d()
                       throws ParseException

Parse an SFVec4d value. If there is more than one double value in the string it will be ignored.

Throws:

ParseException

MFVec4d

public final double[] MFVec4d()
                       throws ParseException

Parse an MFVec4d value.

 MFVec4d ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFRotation

public final float[] SFRotation()
                         throws ParseException

Parse an SFRotation value. If there is more than one float value in the string it will be ignored.

Throws:

ParseException

MFRotation

public final float[] MFRotation()
                         throws ParseException

Parse an MFRotation value.

 MFRotation ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFTime

public final double SFTime()
                    throws ParseException

Parse an SFTime value. If there is more than one float value in the string it will be ignored.

Throws:

ParseException

MFTime

public final double[] MFTime()
                      throws ParseException

Parse an MFTime value. In VRML97 MFTime are not legal field types. However, we provide it here for completeness and that it might be used by VRML 3.0.

 MFTime ::=
   "[" NUMBER_LITERAL* "]" |
   NUMBER_LITERAL*
 

Throws:

ParseException

SFColor

public final float[] SFColor()
                      throws ParseException

Parse an SFColor value. The color differs from the float value by being clamped between 0 and 1. Any more than a single colour value is ignored.

 SFColor ::=
   NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL
 

Throws:

ParseException

MFColor

public final float[] MFColor()
                      throws ParseException

Parse an MFColor value. The color differs from the float value by being clamped between 0 and 1.

 MFColor ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFImage

public final int[] SFImage()
                    throws ParseException

Parse an SFImage value.

 SFImage ::=
   NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL (NUMBER_LITERAL)*
 

Throws:

ParseException

MFImage

public final int[] MFImage()
                    throws ParseException

Parse an MFImage value.

 MFImage ::=
   NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL (NUMBER_LITERAL)*
 

Since we really don't have any control over the number of integers here we just assume a single image and then parse the rest of the integers as quickly as possible.

Throws:

ParseException

SFColorRGBA

public final float[] SFColorRGBA()
                          throws ParseException

Parse an SFColorRGBA value. If there is more than one float value in the string it will be ignored.

 SFColorRGBA ::=
   NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL
 

Throws:

ParseException

MFColorRGBA

public final float[] MFColorRGBA()
                          throws ParseException

Parse an MFColorRGBA value. The color differs from the float value by being clamped between 0 and 1.

 MFColor ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFMatrix3f

public final float[] SFMatrix3f()
                         throws ParseException

Parse an SFMatrix3f value. If there is more than one float value in the string it will be ignored.

Throws:

ParseException

MFMatrix3f

public final float[] MFMatrix3f()
                         throws ParseException

Parse an MFMatrix3f value.

 MFMatrix3f ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFMatrix3d

public final double[] SFMatrix3d()
                          throws ParseException

Parse an SFMatrix3d value. If there is more than one double value in the string it will be ignored.

Throws:

ParseException

MFMatrix3d

public final double[] MFMatrix3d()
                          throws ParseException

Parse an MFMatrix3d value.

 MFMatrix4d ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFMatrix4f

public final float[] SFMatrix4f()
                         throws ParseException

Parse an SFMatrix4f value. If there is more than one float value in the string it will be ignored.

Throws:

ParseException

MFMatrix4f

public final float[] MFMatrix4f()
                         throws ParseException

Parse an MFMatrix4f value.

 MFMatrix4f ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

SFMatrix4d

public final double[] SFMatrix4d()
                          throws ParseException

Parse an SFMatrix4d value. If there is more than one double value in the string it will be ignored.

Throws:

ParseException

MFMatrix4d

public final double[] MFMatrix4d()
                          throws ParseException

Parse an MFMatrix4d value.

 MFMatrix4d ::=
   "[" (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)* "]" |
   (NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL NUMBER_LITERAL)*
 

Throws:

ParseException

ReInit

public void ReInit(InputStream stream)

Reinitialise.

ReInit

public void ReInit(InputStream stream,
 String encoding)

Reinitialise.

ReInit

public void ReInit(Reader stream)

Reinitialise.

ReInit

public void ReInit(X3DFieldParserTokenManager tm)

Reinitialise.

getNextToken

public final Token getNextToken()

Get the next Token.

getToken

public final Token getToken(int index)

Get the specific Token.

generateParseException

public ParseException generateParseException()

Generate ParseException.

enable_tracing

public final void enable_tracing()

Enable tracing.

disable_tracing

public final void disable_tracing()

Disable tracing.