cds.savot.pull
Class SavotPullParser

java.lang.Object
  cds.savot.pull.SavotPullParser

public class SavotPullParser
extends java.lang.Object

It has been tested with kXML Pull parser implementation

but it is possible to use other pull parsers

Designed to use with Pull parsers complient with Standard Pull Implementation v1

Version:

2.6 Copyright CDS 2002-2005 (kickoff 31 May 02)

Author:

Andre Schaaff

Constructor Summary

SavotPullParser(java.io.InputStream instream, int mode, java.lang.String enc)
Constructor

SavotPullParser(java.io.InputStream instream, int mode, java.lang.String enc, boolean debug)
Constructor

SavotPullParser(java.lang.String file, int mode)
Constructor

SavotPullParser(java.lang.String file, int mode, boolean debug)
Constructor

SavotPullParser(java.net.URL url, int mode, java.lang.String enc)
Constructor

SavotPullParser(java.net.URL url, int mode, java.lang.String enc, boolean debug)
Constructor

Method Summary

void	enableDebug(boolean debug) Enable debug mode
SavotVOTable	getAllResources() Get all resources
SavotCoosys	getCoosysFromRef(java.lang.String ref) Search a COOSYS corresponding to an ID ref
long	getDataCount() Get the number of DATA elements in the document (for statistics)
SavotField	getFieldFromRef(java.lang.String ref) Search a FIELD corresponding to an ID ref
java.util.Hashtable	getIdRefLinks() Get a reference on the Hashtable containing the link between ID and ref
SavotInfo	getInfoFromRef(java.lang.String ref) Search a RESOURCE corresponding to an ID ref
SavotLink	getLinkFromRef(java.lang.String ref) Search a LINK corresponding to an ID ref
SavotResource	getNextResource() Get the next Resource (sequential mode only)
SavotParam	getParamFromRef(java.lang.String ref) Search a PARAM corresponding to an ID ref
long	getResourceCount() Get the number of RESOURCE elements in the document (for statistics)
SavotResource	getResourceFromRef(java.lang.String ref) Search a RESOURCE corresponding to an ID ref
long	getTableCount() Get the number of TABLE elements in the document (for statistics)
SavotTable	getTableFromRef(java.lang.String ref) Search a TABLE corresponding to an ID ref
long	getTRCount() Get the number of TR elements in the document (for statistics)
SavotValues	getValuesFromRef(java.lang.String ref) Search a VALUES corresponding to an ID ref
java.lang.String	getVersion() Get Parser Version
SavotVOTable	getVOTable() Get a reference to V0TABLE object
static void	main(java.lang.String[] argv) Main
void	sequentialTester() For test only

Methods inherited from class java.lang.Object

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

Constructor Detail

SavotPullParser

public SavotPullParser(java.lang.String file,
                       int mode)

Constructor

Parameters:

file - a file to parse

mode - FULL or SEQUENTIAL (for small memory size applications)

SavotPullParser

public SavotPullParser(java.lang.String file,
                       int mode,
                       boolean debug)

Constructor

Parameters:

file - a file to parse

mode - FULL or SEQUENTIAL (for small memory size applications)

SavotPullParser

public SavotPullParser(java.net.URL url,
                       int mode,
                       java.lang.String enc)

Constructor

Parameters:

url - url to parse

mode - FULL or SEQUENTIAL (for small memory size applications)

enc - encoding (example : UTF-8)

SavotPullParser

public SavotPullParser(java.net.URL url,
                       int mode,
                       java.lang.String enc,
                       boolean debug)

Constructor

Parameters:

url - url to parse

mode - FULL or SEQUENTIAL (for small memory size applications)

enc - encoding (example : UTF-8)

SavotPullParser

public SavotPullParser(java.io.InputStream instream,
                       int mode,
                       java.lang.String enc)

Constructor

Parameters:

instream - stream to parse

mode - FULL or SEQUENTIAL (for small memory size applications)

enc - encoding (example : UTF-8)

SavotPullParser

public SavotPullParser(java.io.InputStream instream,
                       int mode,
                       java.lang.String enc,
                       boolean debug)

Constructor

Parameters:

instream - stream to parse

mode - FULL or SEQUENTIAL (for small memory size applications)

enc - encoding (example : UTF-8)

Method Detail

getNextResource

public SavotResource getNextResource()

Get the next Resource (sequential mode only)

Returns:

a SavotResource

getVOTable

public SavotVOTable getVOTable()

Get a reference to V0TABLE object

Returns:

SavotVOTable

getResourceCount

public long getResourceCount()

Get the number of RESOURCE elements in the document (for statistics)

Returns:

a long value

getTableCount

public long getTableCount()

Get the number of TABLE elements in the document (for statistics)

Returns:

a long value

getTRCount

public long getTRCount()

Get the number of TR elements in the document (for statistics)

Returns:

a long value

getDataCount

public long getDataCount()

Get the number of DATA elements in the document (for statistics)

Returns:

a long value

getIdRefLinks

public java.util.Hashtable getIdRefLinks()

Get a reference on the Hashtable containing the link between ID and ref

Returns:

a refernce to the Hashtable

getResourceFromRef

public SavotResource getResourceFromRef(java.lang.String ref)

Search a RESOURCE corresponding to an ID ref

Parameters:

ref -

Returns:

a reference to a SavotResource object

getFieldFromRef

public SavotField getFieldFromRef(java.lang.String ref)

Search a FIELD corresponding to an ID ref

Parameters:

ref -

Returns:

SavotField

getParamFromRef

public SavotParam getParamFromRef(java.lang.String ref)

Search a PARAM corresponding to an ID ref

Parameters:

ref -

Returns:

SavotParam

getTableFromRef

public SavotTable getTableFromRef(java.lang.String ref)

Search a TABLE corresponding to an ID ref

Parameters:

ref -

Returns:

SavotTable

getInfoFromRef

public SavotInfo getInfoFromRef(java.lang.String ref)

Search a RESOURCE corresponding to an ID ref

Parameters:

ref -

Returns:

SavotInfo

getValuesFromRef

public SavotValues getValuesFromRef(java.lang.String ref)

Search a VALUES corresponding to an ID ref

Parameters:

ref -

Returns:

SavotValues

getLinkFromRef

public SavotLink getLinkFromRef(java.lang.String ref)

Search a LINK corresponding to an ID ref

Parameters:

ref -

Returns:

SavotLink

getCoosysFromRef

public SavotCoosys getCoosysFromRef(java.lang.String ref)

Search a COOSYS corresponding to an ID ref

Parameters:

ref -

Returns:

SavotCoosys

getAllResources

public SavotVOTable getAllResources()

Get all resources

Returns:

SavotVOTable

getVersion

public java.lang.String getVersion()

Get Parser Version

Returns:

String

sequentialTester

public void sequentialTester()

For test only

enableDebug

public void enableDebug(boolean debug)

Enable debug mode

Parameters:

debug - boolean

main

public static void main(java.lang.String[] argv)
                 throws java.io.IOException

Main

Parameters:

argv -

Throws:

java.io.IOException