Package cds.savot.pull
Class SavotPullParser
- java.lang.Object
-
- cds.savot.pull.SavotPullParser
-
public final class SavotPullParser extends java.lang.ObjectIt 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
- Author:
- Andre Schaaff
-
-
Constructor Summary
Constructors Constructor Description SavotPullParser(java.io.InputStream instream, int mode, java.lang.String enc)ConstructorSavotPullParser(java.io.InputStream instream, int mode, java.lang.String enc, boolean debug)ConstructorSavotPullParser(java.io.Reader reader, int mode)ConstructorSavotPullParser(java.io.Reader reader, int mode, boolean debug)ConstructorSavotPullParser(java.lang.String file, int mode)ConstructorSavotPullParser(java.lang.String file, int mode, boolean debug)ConstructorSavotPullParser(java.net.URL url, int mode, java.lang.String enc)ConstructorSavotPullParser(java.net.URL url, int mode, java.lang.String enc, boolean debug)Constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Close the input stream if still openedvoidenableDebug(boolean debug)Enable debug modeSavotVOTablegetAllResources()Get all resourcesSavotCoosysgetCoosysFromRef(java.lang.String ref)Search a COOSYS corresponding to an ID refintgetDataCount()Get the number of DATA elements in the document (for statistics)SavotFieldgetFieldFromRef(java.lang.String ref)Search a FIELD corresponding to an ID refjava.util.Map<java.lang.String,java.lang.Object>getIdRefLinks()Get a reference on the Hashtable containing the link between ID and refSavotInfogetInfoFromRef(java.lang.String ref)Search a RESOURCE corresponding to an ID refSavotLinkgetLinkFromRef(java.lang.String ref)Search a LINK corresponding to an ID refSavotResourcegetNextResource()Get the next Resource (sequential mode only)SavotTRgetNextTR()Get the next Resource (sequential mode only)SavotParamgetParamFromRef(java.lang.String ref)Search a PARAM corresponding to an ID refintgetResourceCount()Get the number of RESOURCE elements in the document (for statistics)SavotResourcegetResourceFromRef(java.lang.String ref)Search a RESOURCE corresponding to an ID refSavotStatisticsgetStatistics()Returns the statsintgetTableCount()Get the number of TABLE elements in the document (for statistics)SavotTablegetTableFromRef(java.lang.String ref)Search a TABLE corresponding to an ID refintgetTRCount()Get the number of TR elements in the document (for statistics)SavotValuesgetValuesFromRef(java.lang.String ref)Search a VALUES corresponding to an ID refjava.lang.StringgetVersion()Get Parser VersionSavotVOTablegetVOTable()Get a reference to V0TABLE objectstatic voidmain(java.lang.String[] argv)MainvoidsequentialTester()For test only
-
-
-
Constructor Detail
-
SavotPullParser
public SavotPullParser(java.lang.String file, int mode)Constructor- Parameters:
file- a file to parsemode- FULL or RESOURCEREAD/ROWREAD (for small memory size applications)
-
SavotPullParser
public SavotPullParser(java.lang.String file, int mode, boolean debug)Constructor- Parameters:
file- a file to parsemode- FULL or RESOURCEREAD/ROWREAD (for small memory size applications)debug-
-
SavotPullParser
public SavotPullParser(java.net.URL url, int mode, java.lang.String enc)Constructor- Parameters:
url- url to parsemode- FULL or RESOURCEREAD/ROWREAD (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 parsemode- FULL or RESOURCEREAD/ROWREAD (for small memory size applications)enc- encoding (example : UTF-8)debug-
-
SavotPullParser
public SavotPullParser(java.io.InputStream instream, int mode, java.lang.String enc)Constructor- Parameters:
instream- stream to parsemode- FULL or RESOURCEREAD/ROWREAD (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 parsemode- FULL or RESOURCEREAD/ROWREAD (for small memory size applications)enc- encoding (example : UTF-8)debug-
-
SavotPullParser
public SavotPullParser(java.io.Reader reader, int mode)Constructor- Parameters:
reader- reader to parsemode- FULL or RESOURCEREAD/ROWREAD (for small memory size applications)
-
SavotPullParser
public SavotPullParser(java.io.Reader reader, int mode, boolean debug)Constructor- Parameters:
reader- reader to parsemode- FULL or RESOURCEREAD/ROWREAD (for small memory size applications)debug-
-
-
Method Detail
-
close
public void close()
Close the input stream if still opened
-
getStatistics
public SavotStatistics getStatistics()
Returns the stats- Returns:
- statistics
-
getNextResource
public SavotResource getNextResource()
Get the next Resource (sequential mode only)- Returns:
- a SavotResource
-
getNextTR
public SavotTR getNextTR()
Get the next Resource (sequential mode only)- Returns:
- a SavotResource
-
getVOTable
public SavotVOTable getVOTable()
Get a reference to V0TABLE object- Returns:
- SavotVOTable
-
getResourceCount
public int getResourceCount()
Get the number of RESOURCE elements in the document (for statistics)- Returns:
- an int value
-
getTableCount
public int getTableCount()
Get the number of TABLE elements in the document (for statistics)- Returns:
- an int value
-
getTRCount
public int getTRCount()
Get the number of TR elements in the document (for statistics)- Returns:
- an int value
-
getDataCount
public int getDataCount()
Get the number of DATA elements in the document (for statistics)- Returns:
- an int value
-
getIdRefLinks
public java.util.Map<java.lang.String,java.lang.Object> 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
-
enableDebug
public void enableDebug(boolean debug)
Enable debug mode- Parameters:
debug- boolean
-
sequentialTester
public void sequentialTester()
For test only
-
main
public static void main(java.lang.String[] argv) throws java.io.IOExceptionMain- Parameters:
argv-- Throws:
java.io.IOException
-
-