SAXSymbol (jmotif-gi 1.1.0 API)

java.lang.Object
- net.seninp.gi.sequitur.SAXSymbol

Direct Known Subclasses:

SAXGuard, SAXNonTerminal, SAXTerminal
```
public abstract class SAXSymbol
extends Object
```
Template for Sequitur data structures. Adaption of Eibe Frank code for JMotif API.

Author:

Manfred Lerner, seninp

Field Summary

Fields
Modifier and Type	Field and Description
`SAXSymbol`	`n`
`protected static int`	`numTerminals` Apparently, this limits the possible number of terminals, ids of non-terminals start after this num.
`protected int`	`originalPosition` The symbol original position.
`SAXSymbol`	`p` Sort of pointers for previous and the next symbols.
`protected static Hashtable<SAXSymbol,SAXSymbol>`	`theDigrams` Hashtable to keep track of all digrams.
`static Hashtable<String,Hashtable<String,Integer>>`	`theSubstituteTable`
`protected String`	`value` The symbol value.

Constructor Summary

Constructors
Constructor and Description

SAXSymbol()

Constructors
Constructor and Description
`SAXSymbol()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`check()` "Checks in" a new digram and enforce the digram uniqueness constraint.
`abstract void`	`cleanUp()` Cleans up template.
`void`	`deleteDigram()` Removes the digram from the hash table.
`boolean`	`equals(Object obj)` Test if two digrams are equal.
`protected static String`	`getPayload(SAXSymbol symbol)` This routine is used for the debugging.
`int`	`hashCode()` Custom hashcode implementation.
`void`	`insertAfter(SAXSymbol toInsert)` Inserts a symbol after this one.
`boolean`	`isGuard()` Returns true if this is the guard symbol.
`boolean`	`isNonTerminal()` Returns true if this is a non-terminal.
`static void`	`join(SAXSymbol left, SAXSymbol right)` Links left and right symbols together, i.e.
`void`	`match(SAXSymbol theDigram, SAXSymbol matchingDigram)` Deals with a matching digram.
`void`	`substitute(SAXRule r)` Replace a digram with a non-terminal.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - numTerminals
```
protected static final int numTerminals
```
    Apparently, this limits the possible number of terminals, ids of non-terminals start after this num.
    
    See Also:
    
    Constant Field Values
  - theDigrams
```
protected static final Hashtable<SAXSymbol,SAXSymbol> theDigrams
```
    Hashtable to keep track of all digrams. This is static - single instance for all.
  - theSubstituteTable
```
public static Hashtable<String,Hashtable<String,Integer>> theSubstituteTable
```
  - value
```
protected String value
```
    The symbol value.
  - originalPosition
```
protected int originalPosition
```
    The symbol original position.
  - p
```
public SAXSymbol p
```
    Sort of pointers for previous and the next symbols.
  - n
```
public SAXSymbol n
```
- Constructor Detail
  - SAXSymbol
```
public SAXSymbol()
```
- Method Detail
  - join
```
public static void join(SAXSymbol left,
                        SAXSymbol right)
```
    Links left and right symbols together, i.e. removes this symbol from the string, also removing any old digram from the hash table.
    
    Parameters:
    
    left - the left symbol.
    
    right - the right symbol.
  - cleanUp
```
public abstract void cleanUp()
```
    Cleans up template.
  - insertAfter
```
public void insertAfter(SAXSymbol toInsert)
```
    Inserts a symbol after this one.
    
    Parameters:
    
    toInsert - the new symbol to be inserted.
  - deleteDigram
```
public void deleteDigram()
```
    Removes the digram from the hash table. Overwritten in sub class guard.
  - isGuard
```
public boolean isGuard()
```
    Returns true if this is the guard symbol. Overwritten in subclass guard.
    
    Returns:
    
    true if the guard.
  - isNonTerminal
```
public boolean isNonTerminal()
```
    Returns true if this is a non-terminal. Overwritten in subclass nonTerminal.
    
    Returns:
    
    true if the non-terminal.
  - check
```
public boolean check()
```
    "Checks in" a new digram and enforce the digram uniqueness constraint. If it appears elsewhere, deals with it by calling match(), otherwise inserts it into the hash table. Overwritten in subclass guard.
    
    Returns:
    
    true if it is not unique.
  - substitute
```
public void substitute(SAXRule r)
```
    Replace a digram with a non-terminal.
    
    Parameters:
    
    r - a rule to use.
  - match
```
public void match(SAXSymbol theDigram,
                  SAXSymbol matchingDigram)
```
    Deals with a matching digram.
    
    Parameters:
    
    theDigram - the first matching digram.
    
    matchingDigram - the second matching digram.
  - hashCode
```
public int hashCode()
```
    Custom hashcode implementation. Produces the hashcode for a digram using this and the next symbol.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the digram's hash code.
  - equals
```
public boolean equals(Object obj)
```
    Test if two digrams are equal. WARNING: don't use to compare two symbols.
    
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPayload
```
protected static String getPayload(SAXSymbol symbol)
```
    This routine is used for the debugging.
    
    Parameters:
    
    symbol - the symbol we looking into.
    
    Returns:
    
    symbol's payload.

Class SAXSymbol

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

numTerminals

theDigrams

theSubstituteTable

value

originalPosition

p

n

Constructor Detail

SAXSymbol

Method Detail

join

cleanUp

insertAfter

deleteDigram

isGuard

isNonTerminal

check

substitute

match

hashCode

equals

toString

getPayload