org.jplate.tabular.tdv.parser.impl.defaults
Class DefaultTdvParser<B extends TdvBuilderIfc<?>>

java.lang.Object
  org.jplate.foundation.parser.javacc.impl.AbstractJavaccParser<B>
      org.jplate.tabular.tdv.parser.impl.defaults.DefaultTdvParser<B>

All Implemented Interfaces:

JavaccParserIfc<B>, JPlateParserIfc<B>, TabularParserIfc<B>, DefaultTdvParserConstants, TdvParserIfc<B>

public final class DefaultTdvParser<B extends TdvBuilderIfc<?>>
extends AbstractJavaccParser<B>
implements TdvParserIfc<B>, DefaultTdvParserConstants

Default implementation of a TDV (tabbed delimited value) parser.

An example of TDV data follows:

• field 1-1\tfield 1-2\tfield 1-3
• field 2-1\tfield 2-2\tfield 2-3
• field 3-1\tfield 3-2\tfield 3-3

The following are some examples on how to use this class. Assume some implemention of TdvBuilderIfc exists.

• Parsing from an InputStream:

  final TdvBuilderIfc builder = // Some implementation...
  
  final DefaultTdvParserIfc parser = new DefaultTdvParser ();
  
  final InputStream inputStream = new FileInputStream ( "MyTdvFile.tdv" );
  
  parser.parse ( inputStream, builder );
              

• Parsing from a Reader:

  final TdvBuilderIfc builder = // Some implementation...
  
  final DefaultTdvParserIfc parser = new DefaultTdvParser ();
  
  final Reader reader = new FileReader ( "MyTdvFile.tdv" );
  
  parser.parse ( reader, builder );            
              

• Parsing from a String:

  final TdvBuilderIfc builder = // Some implementation...
  
  final DefaultTdvParserIfc parser = new DefaultTdvParser ();
  
  final String string = // Contains TDV data in the form of a String.
  
  parser.parse ( string, builder );                
              

• Parsing from a File:

  final TdvBuilderIfc builder = // Some implementation...
  
  final DefaultTdvParserIfc parser = new DefaultTdvParser ();
  
  final File file = new File ( "MyTdvFile.tdv" );
  
  parser.parse ( file, builder );
              

Please note: This class is not thread-safe.

Modifications:
    $Date: 2008-12-02 12:32:45 -0500 (Tue, 02 Dec 2008) $
    $Revision: 479 $
    $Author: sfloess $
    $HeadURL: https://jplate.svn.sourceforge.net/svnroot/jplate/trunk/src/dev/javacc/org/jplate/tabular/tdv/parser/impl/defaults/DefaultTdvParser.jj $
    

Field Summary

private org.apache.commons.logging.Log	_log Used for logging.
private java.util.Vector	jj_expentries
private int[]	jj_expentry
private int	jj_gen
(package private) SimpleCharStream	jj_input_stream
private int	jj_kind
private int[]	jj_la1
private static int[]	jj_la1_0
Token	jj_nt
private int	jj_ntk
Token	token
DefaultTdvParserTokenManager	token_source

Fields inherited from interface org.jplate.tabular.tdv.parser.impl.defaults.DefaultTdvParserConstants

CR, DEFAULT, DELIMITER, EOF, EOL, ESCAPED_DELIMITER, FIELD, LF, tokenImage

Fields inherited from interface org.jplate.foundation.parser.javacc.JavaccParserIfc

BUILDER_IS_NULL_MSG, FILE_DOES_NOT_EXIST_MSG, FILE_IS_NULL_MSG, INPUT_STREAM_IS_NULL_MSG, READER_IS_NULL_MSG, STRING_IS_EMPTY_MSG

Constructor Summary

DefaultTdvParser()
Default constructor.

DefaultTdvParser(DefaultTdvParserTokenManager tm)

DefaultTdvParser(java.io.InputStream stream)

DefaultTdvParser(java.io.InputStream stream, java.lang.String encoding)

DefaultTdvParser(java.io.Reader stream)

Method Summary

void	disable_tracing()
void	enable_tracing()
ParseException	generateParseException()
Token	getNextToken()
Token	getToken(int index)
private Token	jj_consume_token(int kind)
private static void	jj_la1_0()
private int	jj_ntk()
protected void	parse(B builder) Is called by self to start parsing.
void	ReInit(DefaultTdvParserTokenManager tm)
void	ReInit(java.io.InputStream stream) JavaCC will generate this method so it is not needed to be implemented.
void	ReInit(java.io.InputStream stream, java.lang.String encoding) JavaCC will generate this method so it is not needed to be implemented.
void	ReInit(java.io.Reader stream) JavaCC will generate this method so it is not needed to be implemented.

Methods inherited from class org.jplate.foundation.parser.javacc.impl.AbstractJavaccParser

parse, parse, parse, parse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jplate.foundation.parser.JPlateParserIfc

parse, parse, parse, parse

Field Detail

_log

private final transient org.apache.commons.logging.Log _log

Used for logging.

token_source

public DefaultTdvParserTokenManager token_source

jj_input_stream

SimpleCharStream jj_input_stream

token

public Token token

jj_nt

public Token jj_nt

jj_ntk

private int jj_ntk

jj_gen

private int jj_gen

jj_la1

private final int[] jj_la1

jj_la1_0

private static int[] jj_la1_0

jj_expentries

private java.util.Vector jj_expentries

jj_expentry

private int[] jj_expentry

jj_kind

private int jj_kind

Constructor Detail

DefaultTdvParser

public DefaultTdvParser()

Default constructor.

DefaultTdvParser

public DefaultTdvParser(java.io.InputStream stream)

DefaultTdvParser

public DefaultTdvParser(java.io.InputStream stream,
                        java.lang.String encoding)

DefaultTdvParser

public DefaultTdvParser(java.io.Reader stream)

DefaultTdvParser

public DefaultTdvParser(DefaultTdvParserTokenManager tm)

Method Detail

parse

protected final void parse(B builder)
                    throws ParseException,
                           java.lang.Exception

Description copied from class: AbstractJavaccParser

Is called by self to start parsing.

Specified by:

parse in class AbstractJavaccParser<B extends TdvBuilderIfc<?>>

Parameters:

builder - The object who can create objects from data contained in parser input stream/reader.

Throws:

java.lang.Exception - If any issue arise during parsing.

ParseException

jj_la1_0

private static void jj_la1_0()

ReInit

public void ReInit(java.io.InputStream stream)

Description copied from interface: JavaccParserIfc

JavaCC will generate this method so it is not needed to be implemented.

Specified by:

ReInit in interface JavaccParserIfc<B extends TdvBuilderIfc<?>>

Parameters:

stream - The stream from which parsing will commence.

ReInit

public void ReInit(java.io.InputStream stream,
                   java.lang.String encoding)

Description copied from interface: JavaccParserIfc

JavaCC will generate this method so it is not needed to be implemented.

Specified by:

ReInit in interface JavaccParserIfc<B extends TdvBuilderIfc<?>>

Parameters:

stream - The stream from which parsing will commence.

encoding - The character encoding to use when parsing.

ReInit

public void ReInit(java.io.Reader stream)

Description copied from interface: JavaccParserIfc

JavaCC will generate this method so it is not needed to be implemented.

Specified by:

ReInit in interface JavaccParserIfc<B extends TdvBuilderIfc<?>>

Parameters:

stream - The reader from which parsing will commence.

ReInit

public void ReInit(DefaultTdvParserTokenManager tm)

jj_consume_token

private final Token jj_consume_token(int kind)
                              throws ParseException

Throws:

ParseException

getNextToken

public final Token getNextToken()

getToken

public final Token getToken(int index)

jj_ntk

private final int jj_ntk()

generateParseException

public ParseException generateParseException()

enable_tracing

public final void enable_tracing()

disable_tracing

public final void disable_tracing()