|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--edu.ucsb.nceas.morpho.datapackage.DataPackage
class that represents a data package.
Field Summary | |
static java.lang.String |
BOTH
used to signify that this package is stored on metacat and locally. |
static java.lang.String |
LOCAL
used to signify that this package is located locally |
static java.lang.String |
METACAT
used to signify that this package is located on a metacat server |
Constructor Summary | |
DataPackage(java.lang.String location,
java.lang.String identifier,
java.util.Vector relations,
ClientFramework framework)
Create a new data package object with an id, location and associated relations. |
Method Summary | |
void |
delete(java.lang.String location)
Deletes the package from the specified location |
void |
download()
Downloads a metacat package to the local disk |
void |
export(java.lang.String path)
exports a package to a given path |
void |
exportToZip(java.lang.String path)
Exports a package to a zip file at the given path |
java.lang.String |
getAccessId()
returns the access file's id from the package |
java.util.Vector |
getAllIdentifiers()
returns a vector containing a distinct set of all of the file ids that make up this package |
java.util.Hashtable |
getAttributes()
returns a hashtable of vectors with the basic values in it. |
java.io.File |
getDataFile(java.lang.String entityID)
|
java.lang.String |
getDataFileName(java.lang.String entityID)
|
java.lang.String |
getID()
returns the id of the head of this package (i.e. |
java.lang.String |
getIdentifier()
gets the identifier of the package file |
java.lang.String |
getLocation()
returns the location of the data package. |
java.util.Hashtable |
getRelatedFiles()
returns a hashtable of the related files taken from the triples. |
org.w3c.dom.Document |
getTripleFileDom()
returns the dom representation of the triple file. |
TripleCollection |
getTriples()
gets the triplesCollection created by this object |
java.io.File |
getTriplesFile()
gets the file that contains the package information. |
boolean |
hasDataFile(java.lang.String entityID)
|
boolean |
isDataFileText(java.lang.String entityID)
|
DataPackage |
upload()
uploads the package with the default of automatically updating the ids when a conflict occurs. |
DataPackage |
upload(boolean updateIds)
Uploads a local package to metacat |
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 METACAT
public static final java.lang.String LOCAL
public static final java.lang.String BOTH
Constructor Detail |
public DataPackage(java.lang.String location, java.lang.String identifier, java.util.Vector relations, ClientFramework framework)
location:
- the location of the file ('METACAT' or 'LOCAL')identifier:
- the id of the data package. usually the id of the
file that contains the triples.relations:
- a vector of all relations in this package.Method Detail |
public java.lang.String getLocation()
public java.lang.String getID()
public org.w3c.dom.Document getTripleFileDom()
public java.util.Hashtable getRelatedFiles()
public java.util.Hashtable getAttributes()
public TripleCollection getTriples()
public java.io.File getTriplesFile()
public java.lang.String getIdentifier()
public java.lang.String getAccessId() throws java.io.FileNotFoundException, java.lang.Exception, CacheAccessException
public java.util.Vector getAllIdentifiers()
public DataPackage upload() throws MetacatUploadException
public DataPackage upload(boolean updateIds) throws MetacatUploadException
updateIds
- if this is true, the upload will automatically update
the ids of all of the package documents if an id conflict is found. if
it is false, a MetacatUploadException will be raised when an id conflict
occurspublic void download()
public void delete(java.lang.String location)
locattion
- the location of the package that you want to delete
use either DataPackage.BOTH, DataPackage.METACAT or DataPackage.LOCALpublic void exportToZip(java.lang.String path) throws java.lang.Exception
path
- the path to export the zip file topublic void export(java.lang.String path)
path
- the path to which this package should be exported.public boolean hasDataFile(java.lang.String entityID)
public boolean isDataFileText(java.lang.String entityID)
public java.lang.String getDataFileName(java.lang.String entityID)
public java.io.File getDataFile(java.lang.String entityID)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |