A B C D E F G H I M N O P R S T U V W

A

about - Variable in class de.unirostock.sems.cbarchive.meta.MetaDataObject

The entry this is all about.

addAllDescriptions(File) - Method in class de.unirostock.sems.cbarchive.ArchiveEntry

Add all descriptions in metaDataFile (assuming all are about this entry).

addAllMetaToEntry(Path, ArchiveEntry) - Static method in class de.unirostock.sems.cbarchive.meta.MetaDataFile

Adds all descriptions of a file to a single entry.

addDescription(String, MetaDataObject) - Method in class de.unirostock.sems.cbarchive.meta.MetaDataHolder

Adds another meta object describing this entry.

addDescription(MetaDataObject) - Method in class de.unirostock.sems.cbarchive.meta.MetaDataHolder

Adds another meta object describing this entry.

addEntry(File, String, String) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Adds an entry to the archive.

addEntry(File, String, String, boolean) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Adds an entry to the archive.

addEntry(File, File, String, boolean) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Adds an entry to the archive.

addEntry(File, File, String) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Adds an entry to the archive.

addEntry(File, File, String, OmexDescription, boolean) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Deprecated.

as of version 0.5, replaced by addEntry(java.io.File,java.io.File,java.lang.String,boolean)

addEntry(File, File, String, OmexDescription) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Deprecated.

as of version 0.5, replaced by addEntry(java.io.File,java.io.File,java.lang.String)

addMainEntry(ArchiveEntry) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Adds an entry to the list of main entries in this archive.

ArchiveEntry - Class in de.unirostock.sems.cbarchive

The Class ArchiveEntry represents a single entry in a CombineArchive.

ArchiveEntry(CombineArchive, Path, String) - Constructor for class de.unirostock.sems.cbarchive.ArchiveEntry

Instantiates a new archive entry.

B

BUFFER_SIZE - Static variable in class de.unirostock.sems.cbarchive.Utils

The default buffer size.

C

clearErrors() - Method in class de.unirostock.sems.cbarchive.CombineArchive

Clear all errors.

close() - Method in class de.unirostock.sems.cbarchive.CombineArchive

CombineArchive - Class in de.unirostock.sems.cbarchive

The Class CombineArchive to create/read/manipulate/store etc.

CombineArchive(File) - Constructor for class de.unirostock.sems.cbarchive.CombineArchive

Instantiates a new empty combine archive.

CombineArchive(File, boolean) - Constructor for class de.unirostock.sems.cbarchive.CombineArchive

Instantiates a new empty combine archive.

CombineArchiveException - Exception in de.unirostock.sems.cbarchive

The Class CombineArchiveException representing an error while processing CombineArchives.

CombineArchiveException(String) - Constructor for exception de.unirostock.sems.cbarchive.CombineArchiveException

Instantiates a new CombineArchiveException.

CombineFormats - Class in de.unirostock.sems.cbarchive

The Class CombineArchive to ease the interaction with formats.

CombineFormats() - Constructor for class de.unirostock.sems.cbarchive.CombineFormats

COPY_OPTION - Static variable in class de.unirostock.sems.cbarchive.Utils

The COPY_OPTION used to copy/move files.

createExample() - Static method in class de.unirostock.sems.cbarchive.Example

Creates an example archive in /tmp/testArchive.zip.

D

dateFormater - Static variable in class de.unirostock.sems.cbarchive.Utils

The date formater.

dcNS - Static variable in class de.unirostock.sems.cbarchive.Utils

The DC namespace.

de.unirostock.sems.cbarchive - package de.unirostock.sems.cbarchive

de.unirostock.sems.cbarchive.meta - package de.unirostock.sems.cbarchive.meta

de.unirostock.sems.cbarchive.meta.omex - package de.unirostock.sems.cbarchive.meta.omex

DefaultMetaDataObject - Class in de.unirostock.sems.cbarchive.meta

The Class DefaultMetaDataObject, a fall back if we do not understand the meta data that is encoded in the XML.

DefaultMetaDataObject(Element) - Constructor for class de.unirostock.sems.cbarchive.meta.DefaultMetaDataObject

Instantiates a new default meta data object.

delete(File) - Static method in class de.unirostock.sems.cbarchive.Utils

Recursively delete file or directory.

description - Variable in class de.unirostock.sems.cbarchive.meta.MetaDataObject

The description.

description - Variable in class de.unirostock.sems.cbarchive.meta.OmexMetaDataObject

The description.

descriptions - Variable in class de.unirostock.sems.cbarchive.meta.MetaDataHolder

The descriptions about the entity.

E

Example - Class in de.unirostock.sems.cbarchive

execute these commands before running the example:

Example() - Constructor for class de.unirostock.sems.cbarchive.Example

extract(Path, File) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Extract an entry from this archive.

extractFile(File) - Method in class de.unirostock.sems.cbarchive.ArchiveEntry

Extract this file to target.

extractTo(File) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Extract the whole archive to the disk.

F

fragmentIdentifier - Variable in class de.unirostock.sems.cbarchive.meta.MetaDataObject

The fragment identifier.

G

getAbout() - Method in class de.unirostock.sems.cbarchive.meta.MetaDataObject

Gets the about.

getArchive() - Method in class de.unirostock.sems.cbarchive.ArchiveEntry

Gets the archive that contains this entry.

getCreated() - Method in class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Gets the date created.

getCreators() - Method in class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Gets the creators.

getDescription() - Method in class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Gets the description.

getDescriptions() - Method in class de.unirostock.sems.cbarchive.meta.MetaDataHolder

Gets the MetaDataObjects describing this entity.

getElementsByTagName(Element, String, Namespace) - Static method in class de.unirostock.sems.cbarchive.Utils

Gets elements of an XML subtree by tag name.

getEmail() - Method in class de.unirostock.sems.cbarchive.meta.omex.VCard

Gets the email address.

getEntityPath() - Method in class de.unirostock.sems.cbarchive.ArchiveEntry

Gets the path to this entity.

getEntityPath() - Method in class de.unirostock.sems.cbarchive.CombineArchive

getEntityPath() - Method in class de.unirostock.sems.cbarchive.meta.MetaDataHolder

Gets the path to this entity.

getEntries() - Method in class de.unirostock.sems.cbarchive.CombineArchive

Retrieves all entries.

getEntriesWithFormat(String) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Gets entries sharing a certain format.

getEntry(String) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Retrieves an entry stored at a specified location.

getEntryByLocation(String) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Retireves an entry by its location.

getEnumerator() - Method in class de.unirostock.sems.cbarchive.CombineArchive

Gets the enumerator of entries.

getErrors() - Method in class de.unirostock.sems.cbarchive.CombineArchive

Gets the errors that occurred during creating/reading of an archive.

getExtension(String) - Static method in class de.unirostock.sems.cbarchive.Utils

Extracts the extension of a filename.

getFamilyName() - Method in class de.unirostock.sems.cbarchive.meta.omex.VCard

Gets the family name.

getFile() - Method in class de.unirostock.sems.cbarchive.ArchiveEntry

Deprecated.

as of version 0.6, replaced by (File target)

getFileName() - Method in class de.unirostock.sems.cbarchive.ArchiveEntry

Gets the file name (w/o path) of this entry in the archive.

getFilePath() - Method in class de.unirostock.sems.cbarchive.ArchiveEntry

Gets the relative path name of this file in the archive.

getFormat() - Method in class de.unirostock.sems.cbarchive.ArchiveEntry

Gets the format as reported by the archive's manifest.

getFormatFromIdentifier(String) - Static method in class de.unirostock.sems.cbarchive.CombineFormats

Gets the format of an identifier.

getFormatIdentifier(String) - Static method in class de.unirostock.sems.cbarchive.CombineFormats

Gets the official identifier of a certain format.

getGivenName() - Method in class de.unirostock.sems.cbarchive.meta.omex.VCard

Gets the given name.

getMainEntries() - Method in class de.unirostock.sems.cbarchive.CombineArchive

Gets the main entries as defined in the archive.

getMainEntry() - Method in class de.unirostock.sems.cbarchive.CombineArchive

Deprecated.

as of version 0.8.2, replaced by getMainEntries()

getModified() - Method in class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Gets the dates modified.

getNumEntries() - Method in class de.unirostock.sems.cbarchive.CombineArchive

Gets the number of entries stored in this archive.

getNumEntriesWithFormat(String) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Counts entries with a certain format.

getOmexDescription() - Method in class de.unirostock.sems.cbarchive.meta.OmexMetaDataObject

Gets the omex description.

getOrganization() - Method in class de.unirostock.sems.cbarchive.meta.omex.VCard

Gets the organization.

getPath() - Method in class de.unirostock.sems.cbarchive.ArchiveEntry

Gets the path to this entry.

getXmlDescription() - Method in class de.unirostock.sems.cbarchive.meta.MetaDataObject

Get the XML description of MetaDataObject.getAbout().

H

HasEntriesWithFormat(String) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Checks whether there are entries with a certain format.

hasErrors() - Method in class de.unirostock.sems.cbarchive.CombineArchive

Checks for errors.

I

injectDescription(Element) - Method in class de.unirostock.sems.cbarchive.meta.DefaultMetaDataObject

injectDescription(Element) - Method in class de.unirostock.sems.cbarchive.meta.MetaDataObject

Inject the description into parent.

injectDescription(Element) - Method in class de.unirostock.sems.cbarchive.meta.OmexMetaDataObject

isEmpty() - Method in class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Checks if description is empty.

isEmpty() - Method in class de.unirostock.sems.cbarchive.meta.omex.VCard

Checks if the VCard is empty.

M

main(String[]) - Static method in class de.unirostock.sems.cbarchive.CombineFormats

The main method to update our format dictionary.

main(String[]) - Static method in class de.unirostock.sems.cbarchive.Example

Main - Class in de.unirostock.sems.cbarchive

Main() - Constructor for class de.unirostock.sems.cbarchive.Main

main(String[]) - Static method in class de.unirostock.sems.cbarchive.Main

MANIFEST_LOCATION - Static variable in class de.unirostock.sems.cbarchive.CombineArchive

The Constant MANIFEST_LOCATION.

METADATA_LOCATION - Static variable in class de.unirostock.sems.cbarchive.CombineArchive

The Constant METADATA_LOCATION.

MetaDataFile - Class in de.unirostock.sems.cbarchive.meta

The Class MetaDataFile providing some static functions to read and write meta data files.

MetaDataFile() - Constructor for class de.unirostock.sems.cbarchive.meta.MetaDataFile

MetaDataHolder - Class in de.unirostock.sems.cbarchive.meta

The Class MetaDataHolder representing objects that may contain meta data.

MetaDataHolder() - Constructor for class de.unirostock.sems.cbarchive.meta.MetaDataHolder

Instantiates a new MetaDataHolder.

MetaDataObject - Class in de.unirostock.sems.cbarchive.meta

The abstract Class MetaDataObject representing some meta data.

MetaDataObject(Element) - Constructor for class de.unirostock.sems.cbarchive.meta.MetaDataObject

Instantiates a new meta data object.

modified - Variable in class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

The dates modified.

moveEntry(String, String) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Move an entry.

N

NEWLINE - Static variable in class de.unirostock.sems.cbarchive.Utils

The newline character.

O

OmexDescription - Class in de.unirostock.sems.cbarchive.meta.omex

The Class OmexDescription to parse and create meta data for entries in CombineArchives.

OmexDescription() - Constructor for class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Instantiates a new omex description.

OmexDescription(List<VCard>, List<Date>) - Constructor for class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Instantiates a new omex description.

OmexDescription(VCard, Date) - Constructor for class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Instantiates a new omex description.

OmexDescription(List<VCard>, Date) - Constructor for class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Instantiates a new omex description.

OmexDescription(List<VCard>, List<Date>, Date) - Constructor for class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Instantiates a new omex description.

OmexDescription(Element) - Constructor for class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Instantiates a new omex description parsed from an XML subtree.

OmexMetaDataObject - Class in de.unirostock.sems.cbarchive.meta

The Class OmexMetaDataObject representing meta data in OMEX format.

OmexMetaDataObject(OmexDescription) - Constructor for class de.unirostock.sems.cbarchive.meta.OmexMetaDataObject

Instantiates a new OMEX meta data object.

OmexMetaDataObject(OmexDescription, Element) - Constructor for class de.unirostock.sems.cbarchive.meta.OmexMetaDataObject

Instantiates a new OMEX meta data object.

omexNs - Static variable in class de.unirostock.sems.cbarchive.Utils

The OMEX namespace.

omexSpecNs - Static variable in class de.unirostock.sems.cbarchive.Utils

The OMEX spec namespace.

P

pack(boolean) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Pack this archive: generates manifest and meta data files.

pack() - Method in class de.unirostock.sems.cbarchive.CombineArchive

Pack this archive.

prettyPrintDocument(Document) - Static method in class de.unirostock.sems.cbarchive.Utils

Pretty print an XML document.

R

rdfNS - Static variable in class de.unirostock.sems.cbarchive.Utils

The RDF namespace.

readExample() - Static method in class de.unirostock.sems.cbarchive.Example

Reads the example in /tmp/testArchive.zip.

readFile(Path, HashMap<String, ArchiveEntry>, CombineArchive, boolean, List<String>) - Static method in class de.unirostock.sems.cbarchive.meta.MetaDataFile

Read a meta data file containing descriptions about the archive and/or its entries given in entries.

readXmlDocument(Path) - Static method in class de.unirostock.sems.cbarchive.Utils

Reads an XML file and creates a Document.

removeDescription(MetaDataObject) - Method in class de.unirostock.sems.cbarchive.meta.MetaDataHolder

Removes a certain description of this entity.

removeEntry(String) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Removes an entry defined by its relative location from the archive.

removeEntry(ArchiveEntry) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Removes an entry from the archive.

removeMainEntry(ArchiveEntry) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Removes an entry from the list of main entries.

reset() - Method in class de.unirostock.sems.cbarchive.Utils.SimpleOutputStream

Reset.

S

setAbout(MetaDataHolder) - Method in class de.unirostock.sems.cbarchive.meta.MetaDataObject

Sets the about.

setAbout(MetaDataHolder, String) - Method in class de.unirostock.sems.cbarchive.meta.MetaDataObject

Sets the about.

setMainEntry(ArchiveEntry) - Method in class de.unirostock.sems.cbarchive.CombineArchive

Sets a main entry of the archive.

T

toJsonDescription() - Method in class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Export a JSON description of this OMEX description.

toJsonObject() - Method in class de.unirostock.sems.cbarchive.meta.omex.VCard

Export this VCard as a JSON object.

toString() - Method in class de.unirostock.sems.cbarchive.Utils.SimpleOutputStream

toXML(Element) - Method in class de.unirostock.sems.cbarchive.meta.omex.OmexDescription

Attach the description to an XML tree.

toXml(Element) - Method in class de.unirostock.sems.cbarchive.meta.omex.VCard

Appends the VCard tree to an XML element.

tryToRead(Element) - Static method in class de.unirostock.sems.cbarchive.meta.DefaultMetaDataObject

Try to read a meta data object.

tryToRead(Element) - Static method in class de.unirostock.sems.cbarchive.meta.OmexMetaDataObject

Try to read a meta data object.

U

Utils - Class in de.unirostock.sems.cbarchive

Some tools.

Utils() - Constructor for class de.unirostock.sems.cbarchive.Utils

Utils.SimpleOutputStream - Class in de.unirostock.sems.cbarchive

The Class SimpleOutputStream.

Utils.SimpleOutputStream() - Constructor for class de.unirostock.sems.cbarchive.Utils.SimpleOutputStream

V

VCard - Class in de.unirostock.sems.cbarchive.meta.omex

The Class VCard representing a VCard entity of the Omex description.

VCard() - Constructor for class de.unirostock.sems.cbarchive.meta.omex.VCard

Instantiates an empty VCard.

VCard(String, String, String, String) - Constructor for class de.unirostock.sems.cbarchive.meta.omex.VCard

Instantiates a new VCard.

VCard(Element) - Constructor for class de.unirostock.sems.cbarchive.meta.omex.VCard

Instantiates a new VCard from an entity of the Omex description.

vcNS - Static variable in class de.unirostock.sems.cbarchive.Utils

The vcard namespace.

W

write(int) - Method in class de.unirostock.sems.cbarchive.Utils.SimpleOutputStream

writeFile(File, HashMap<String, ArchiveEntry>, CombineArchive) - Static method in class de.unirostock.sems.cbarchive.meta.MetaDataFile

Write the meta data about the archive and its entries given in archive and entries to a single meta data file.

writeFiles(File, HashMap<String, ArchiveEntry>, CombineArchive) - Static method in class de.unirostock.sems.cbarchive.meta.MetaDataFile

Write the meta data about the archive and its entries given in archive and entries to a single meta data files.

A B C D E F G H I M N O P R S T U V W