uk.ac.vamsas.client.simpleclient
Class VamsasArchiveReader

java.lang.Object
  extended byuk.ac.vamsas.client.simpleclient.VamsasArchiveReader

public class VamsasArchiveReader
extends java.lang.Object

Basic methods for accessing an existing Vamsas Archive, and Jar entry names for creating new vamsas archives.

Author:
jimp

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

DOCUMENT_VERSION

public static final java.lang.String DOCUMENT_VERSION
the vamsas document version(s) handled by this Reader

See Also:
Constant Field Values

VAMSASDOC

public static final java.lang.String VAMSASDOC
name of the jarEntry containing a well formatted vamsas XML Document

See Also:
Constant Field Values

VAMSASXML

public static final java.lang.String VAMSASXML
name of the jarEntry containing a root VAMSAS element, and containing a random sequence of VAMSAS DataSet elements

See Also:
Constant Field Values
Constructor Detail

VamsasArchiveReader

public VamsasArchiveReader(java.io.File vamsasfile)

VamsasArchiveReader

public VamsasArchiveReader(Lock vamsaslock)
in an ideal world - this constructor will create a reader object for the locked file's random access stream.

Parameters:
vamsaslock -
Method Detail

getVamsasDocumentEntry

protected ZipEntry getVamsasDocumentEntry()
Returns:
JarEntry for VamsasArchiveReader.VAMSASDOC

getVamsasXmlEntry

protected ZipEntry getVamsasXmlEntry()
Returns:
JarEntry for VamsasArchiveReader.VAMSASXML

isValid

public boolean isValid()
Test for valid vamsas document archive

Returns:
true if getVamsasDocumentStream will return a stream likely to contain valid XML

getAppdataEntry

protected ZipEntry getAppdataEntry(java.lang.String AppdataRef)

getAppdataStream

public java.io.InputStream getAppdataStream(java.lang.String AppdataRef)

getVamsasDocumentStream

public java.io.InputStream getVamsasDocumentStream()
get the VamsasDocument input stream, if it exists.

Returns:
null or valid input stream

getVamsasXmlStream

public java.io.InputStream getVamsasXmlStream()
get the VamsasXML input stream, if it exists. Note: Deprecated beyond our prealpha testing.

Returns:
null or valid input stream.

close

public void close()
silently close the jar file.


getExtraEntries

public java.util.Vector getExtraEntries()
returns all entries not matching the filespec of a vamsas xml entry

Returns:
array of entries.