|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.vamsas.client.simpleclient.VamsasArchiveReader
Basic methods for accessing an existing Vamsas Archive, and Jar entry names for creating new vamsas archives.
Field Summary | |
static java.lang.String |
DOCUMENT_VERSION
the vamsas document version(s) handled by this Reader |
static java.lang.String |
VAMSASDOC
name of the jarEntry containing a well formatted vamsas XML Document |
static java.lang.String |
VAMSASXML
name of the jarEntry containing a root VAMSAS element, and containing a random sequence of VAMSAS DataSet elements |
Constructor Summary | |
VamsasArchiveReader(java.io.File vamsasfile)
|
|
VamsasArchiveReader(Lock vamsaslock)
in an ideal world - this constructor will create a reader object for the locked file's random access stream. |
Method Summary | |
void |
close()
silently close the jar file. |
protected ZipEntry |
getAppdataEntry(java.lang.String AppdataRef)
|
java.io.InputStream |
getAppdataStream(java.lang.String AppdataRef)
|
java.util.Vector |
getExtraEntries()
returns all entries not matching the filespec of a vamsas xml entry |
protected ZipEntry |
getVamsasDocumentEntry()
|
java.io.InputStream |
getVamsasDocumentStream()
get the VamsasDocument input stream, if it exists. |
protected ZipEntry |
getVamsasXmlEntry()
|
java.io.InputStream |
getVamsasXmlStream()
get the VamsasXML input stream, if it exists. |
boolean |
isValid()
Test for valid vamsas document archive |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String DOCUMENT_VERSION
public static final java.lang.String VAMSASDOC
public static final java.lang.String VAMSASXML
Constructor Detail |
public VamsasArchiveReader(java.io.File vamsasfile)
public VamsasArchiveReader(Lock vamsaslock)
vamsaslock
- Method Detail |
protected ZipEntry getVamsasDocumentEntry()
protected ZipEntry getVamsasXmlEntry()
public boolean isValid()
protected ZipEntry getAppdataEntry(java.lang.String AppdataRef)
public java.io.InputStream getAppdataStream(java.lang.String AppdataRef)
public java.io.InputStream getVamsasDocumentStream()
public java.io.InputStream getVamsasXmlStream()
public void close()
public java.util.Vector getExtraEntries()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |