public final class SavotStaxParser extends java.lang.Object implements Markups
It has been tested with Java 1.6 Stax implementation but it is possible to use other Stax implementations
Designed to use with JSR-173 compliant (Streaming API for XML)
remark L. Bourgès : equalsIgnoreCase() vs() equals as XML is case sensitive and VOTable specification says that clearly
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_STACK_CAPACITY
default stack capacity = 4 slots
|
static int |
FULL
FULL parsing mode: deprecated and replaced by FULLREAD
|
static int |
FULLREAD
FULLREAD parsing mode: all in memory
|
static int |
RESOURCEREAD
RESOURCEREAD parsing mode: resource per resource reading
|
static int |
ROWREAD
ROWREAD parsing mode: row per row reading
|
static int |
SEQUENTIAL
SEQUENTIAL parsing mode: deprecated and replaced by RESOURCEREAD
|
ACTION, ACTUATE, ARRAYSIZE, BINARY, CONTENTROLE, CONTENTTYPE, COOSYS, DATA, DATATYPE, DEFINITIONS, DESCRIPTION, ENCODING, EPOCH, EQUINOX, EXPIRES, EXTNUM, FIELD, FIELDREF, FITS, GREF, GROUP, HREF, ID, INCLUSIVE, INFO, INVALID, LINK, MAX, MIN, NAME, NROWS, NULL, OPTION, PARAM, PARAMREF, PRECISION, REF, RESOURCE, RIGHTS, SAVOTPARSER, STREAM, SYSTEM, SYSTEM_ATTRIBUTE, TABLE, TABLEDATA, TD, TITLE, TR, TYPE, UCD, UNIT, UTYPE, VALUE, VALUES, VERSION, VOTABLE, WIDTH, XML, XMLNS, XMLNSXSI, XSI, XSI_NOSCHEMA, XSI_SCHEMA, XSINOSCHEMA, XSISCHEMA, XTYPE
Constructor and Description |
---|
SavotStaxParser(java.io.InputStream instream,
int mode)
Constructor
|
SavotStaxParser(java.io.InputStream instream,
int mode,
boolean debug)
Constructor
|
SavotStaxParser(java.io.InputStream instream,
int mode,
boolean debug,
SavotStatistics stats)
Constructor
|
SavotStaxParser(java.io.Reader reader,
int mode)
Constructor
|
SavotStaxParser(java.io.Reader reader,
int mode,
boolean debug)
Constructor
|
SavotStaxParser(java.io.Reader reader,
int mode,
boolean debug,
SavotStatistics stats)
Constructor
|
SavotStaxParser(java.lang.String file,
int mode)
Constructor
|
SavotStaxParser(java.lang.String file,
int mode,
boolean debug)
Constructor
|
SavotStaxParser(java.lang.String file,
int mode,
boolean debug,
SavotStatistics stats)
Constructor
|
SavotStaxParser(java.net.URL url,
int mode)
Constructor
|
SavotStaxParser(java.net.URL url,
int mode,
boolean debug)
Constructor
|
SavotStaxParser(java.net.URL url,
int mode,
boolean debug,
SavotStatistics stats)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the input stream if still opened and free the internal parser
|
void |
enableDebug(boolean debug)
Enable debug mode
|
SavotVOTable |
getAllResources()
Get current VOTable (all resources)
|
SavotCoosys |
getCoosysFromRef(java.lang.String ref)
Search a COOSYS corresponding to an ID ref
|
int |
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
|
SavotFieldRef |
getFieldRefFromRef(java.lang.String ref)
Search a FIELDref corresponding to an ID ref
|
SavotGroup |
getGroupFromRef(java.lang.String ref)
Search a GROUP corresponding to an ID ref
|
java.util.Map<java.lang.String,java.lang.Object> |
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 (warning : RESOURCEREAD mode only)
|
SavotTR |
getNextTR()
Get the next TR (warning : ROWREAD mode only)
|
SavotParam |
getParamFromRef(java.lang.String ref)
Search a PARAM corresponding to an ID ref
|
SavotParamRef |
getParamRefFromRef(java.lang.String ref)
Search a PARAMref corresponding to an ID ref
|
int |
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
|
SavotStatistics |
getStatistics()
Returns the statistics
|
int |
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
|
int |
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 |
parse(int parsingType)
Parsing engine
|
void |
reset()
Reset of the engine before another parsing
LBO: useless methods ?
|
void |
sequentialTester()
For test only
|
public static final int FULL
public static final int FULLREAD
public static final int SEQUENTIAL
public static final int RESOURCEREAD
public static final int ROWREAD
public static final int DEFAULT_STACK_CAPACITY
public SavotStaxParser(java.lang.String file, int mode) throws java.io.IOException, javax.xml.stream.XMLStreamException
file
- a file to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.lang.String file, int mode, boolean debug) throws java.io.IOException, javax.xml.stream.XMLStreamException
file
- a file to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)debug
- java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.lang.String file, int mode, boolean debug, SavotStatistics stats) throws java.io.IOException, javax.xml.stream.XMLStreamException
file
- a file to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)debug
- stats
- java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.net.URL url, int mode) throws java.io.IOException, javax.xml.stream.XMLStreamException
url
- url to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.net.URL url, int mode, boolean debug) throws java.io.IOException, javax.xml.stream.XMLStreamException
url
- url to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)debug
- java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.net.URL url, int mode, boolean debug, SavotStatistics stats) throws java.io.IOException, javax.xml.stream.XMLStreamException
url
- url to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)debug
- stats
- java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.io.InputStream instream, int mode) throws java.io.IOException, javax.xml.stream.XMLStreamException
instream
- stream to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.io.InputStream instream, int mode, boolean debug) throws java.io.IOException, javax.xml.stream.XMLStreamException
instream
- stream to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)debug
- java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.io.InputStream instream, int mode, boolean debug, SavotStatistics stats) throws java.io.IOException, javax.xml.stream.XMLStreamException
instream
- stream to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)debug
- stats
- java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.io.Reader reader, int mode) throws java.io.IOException, javax.xml.stream.XMLStreamException
reader
- reader to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.io.Reader reader, int mode, boolean debug) throws java.io.IOException, javax.xml.stream.XMLStreamException
reader
- reader to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)debug
- java.io.IOException
javax.xml.stream.XMLStreamException
public SavotStaxParser(java.io.Reader reader, int mode, boolean debug, SavotStatistics stats) throws java.io.IOException, javax.xml.stream.XMLStreamException
reader
- reader to parsemode
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)debug
- stats
- java.io.IOException
javax.xml.stream.XMLStreamException
public void close()
public void reset()
public void parse(int parsingType) throws java.io.IOException, javax.xml.stream.XMLStreamException
parsingType
- FULLREAD (all in memory), RESOURCEREAD (per RESOURCE) or
ROWREAD (per ROW, for small memory size applications)java.io.IOException
javax.xml.stream.XMLStreamException
public SavotResource getNextResource()
public SavotTR getNextTR()
public SavotVOTable getVOTable()
public int getResourceCount()
public int getTableCount()
public int getTRCount()
public int getDataCount()
public java.util.Map<java.lang.String,java.lang.Object> getIdRefLinks()
public SavotResource getResourceFromRef(java.lang.String ref)
ref
- public SavotField getFieldFromRef(java.lang.String ref)
ref
- public SavotFieldRef getFieldRefFromRef(java.lang.String ref)
ref
- public SavotParam getParamFromRef(java.lang.String ref)
ref
- public SavotParamRef getParamRefFromRef(java.lang.String ref)
ref
- public SavotTable getTableFromRef(java.lang.String ref)
ref
- public SavotGroup getGroupFromRef(java.lang.String ref)
ref
- public SavotInfo getInfoFromRef(java.lang.String ref)
ref
- public SavotValues getValuesFromRef(java.lang.String ref)
ref
- public SavotLink getLinkFromRef(java.lang.String ref)
ref
- public SavotCoosys getCoosysFromRef(java.lang.String ref)
ref
- public SavotVOTable getAllResources()
public void enableDebug(boolean debug)
debug
- booleanpublic SavotStatistics getStatistics()
public java.lang.String getVersion()
public void sequentialTester()
public static void main(java.lang.String[] argv) throws java.lang.Exception
argv
- java.lang.Exception