    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class xe.xe_TokenTypeDefn

    java.lang.Object
       |
       +----xe.xe_TokenTypeDefn

public class xe_TokenTypeDefn
extends Object

Class xe_TokenTypeDefn - The full definition of a particular XML keyword. Token types define the low-level tokens (reserved words, sequences of symbols and other constructs) which make up XML, and the definition of each token type specifies a little about how it can be used, and whether it is a subset of some other token type. The attributes of an xe_TokenTypeDefn are used to control certain aspects of the low-level parsing.

##

MoreControl
  Are there other token types which begin with this string value? This value was added to drive autoparsing (see class xe_AutoParseManager), although that is now considered more as an interesting experiment than anything else.
NodeType
  If this token represents the beginning of a node, this is the type of node.
TokenType
  The type of this token.
TokenTypeString
  A string representation of the type of this token.
TokenValue
  The string value of this token type.
ValidTokenFlag
  If we parsed this value, could it be considered a valid token? True means it can; false means it cannot.

##

xe_TokenTypeDefn(String, int, String, int, boolean, int)
  Construct a token type definition.

##

getMoreControl()
  Get the value specifying whether there are others beginning with these characters.
getNodeType()
  Get the type of the node for which this is the opening token.
getType()
  Get the type of the token.
getTypeString()
  Get the string representation of the type of the token.
getValidTokenFlag()
  Get the value specifying whether this is a valid token type.
getValue()
  Get the string value of the token type.
setType(int)
  Set the type of this token.
setTypeString(String)
  Set the string representation of the type of this token.
setValue(String)
  Set the string value of this token type.
toString()
  Return a string representation of this token type definition - mainly to be used for debug purposes.

##

TokenValue

     protected String TokenValue

  The string value of this token type.

TokenType

     protected int TokenType

  The type of this token.

TokenTypeString

     protected String TokenTypeString

  A string representation of the type of this token.

NodeType

     protected int NodeType

  If this token represents the beginning of a node, this is the type of node.

ValidTokenFlag

     protected boolean ValidTokenFlag

  If we parsed this value, could it be considered a valid token? True means it can; false means it cannot.

MoreControl

     protected int MoreControl

  Are there other token types which begin with this string value? This value was added to drive autoparsing (see class xe_AutoParseManager), although that is now considered more as an interesting experiment than anything else. The allowed values are: xe_TokenTypeRegistry.NO_MORE - no other token types begin with these characters xe_TokenTypeRegistry.MORE_SPECIAL - by following this with one non-alphanumeric character (and maybe other characters), we may get another valid token type xe_TokenTypeRegistry.MORE_NAME - by following this with a name, we may get another valid token type xe_TokenTypeRegistry.MORE_NUMBER - by following this with a name, we may get another valid token type xe_TokenTypeRegistry.MORE_ANY - by following this with either special characters or a name, we may get another valid token type.

##

xe_TokenTypeDefn

     public xe_TokenTypeDefn(String InputTokenValue,
                             int InputTokenType,
                             String InputTokenTypeString,
                             int InputNodeType,
                             boolean InputValidTokenFlag,
                             int InputMoreControl)

  Construct a token type definition.

  Parameters:
    InputTokenValue - The string value of this token type
    InputTokenType - Type of the token
    InputTokenTypeString - String representation of the token type
    InputNodeType - Type of the node for which this is the opening token (or 0 if it is not the beginning of a node)
    InputValidTokenFlag - If we parsed this value, could it be considered a valid token?
    InputMoreControl - Are there other token types which begin with this string value? The allowed values are: xe_TokenTypeRegistry.NO_MORE, xe_TokenTypeRegistry.MORE_SPECIAL, xe_TokenTypeRegistry.MORE_NAME, xe_TokenTypeRegistry.MORE_NUMBER, xe_TokenTypeRegistry.MORE_ANY.

##

getValue

     public String getValue()

  Get the string value of the token type.

  Returns:
    The string value of the token type

getType

     public int getType()

  Get the type of the token.

  Returns:
    The type of the token

getTypeString

     public String getTypeString()

  Get the string representation of the type of the token.

  Returns:
    String representation of the token type

getNodeType

     public int getNodeType()

  Get the type of the node for which this is the opening token.

  Returns:
    The type of the node for which this is the opening token. 0 means this is not the opening token of a node.

getValidTokenFlag

     public boolean getValidTokenFlag()

  Get the value specifying whether this is a valid token type.

  Returns:
    If we parsed this value, could it be considered a valid token?

getMoreControl

     public int getMoreControl()

  Get the value specifying whether there are others beginning with these characters.

  Returns:
    Are there other token types which begin with this string value?

toString

     public String toString()

  Return a string representation of this token type definition - mainly to be used for debug purposes.

  Returns:
    String representation of this token type definition
  Overrides:
    toString in class Object

setValue

     public void setValue(String InputTokenValue)

  Set the string value of this token type.

  Parameters:
    InputTokenValue - String value of this token type

setType

     public void setType(int InputTokenType)

  Set the type of this token.

  Parameters:
    InputTokenType - Type of this token

setTypeString

     public void setTypeString(String InputTokenTypeString)

  Set the string representation of the type of this token.

  Parameters:
    InputTokenTypeString - String representation of this token type

    All Packages  Class Hierarchy  This Package  Previous  Next  Index