Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- accepts(ZipEntry) - Method in interface org.openpreservation.format.zip.ZipEntryProcessor
-
Returns
true
if the processor accepts the suppliedZipEntry
for processing. - add(String, Collection<? extends Message>) - Method in interface org.openpreservation.messages.MessageLog
-
Add a
Collection
ofMessages
to the log for a particular path. - add(String, Collection<? extends Message>) - Method in class org.openpreservation.odf.validation.ValidationReport
- add(String, Message) - Method in interface org.openpreservation.messages.MessageLog
-
Add a
Message
to the log for a particular path. - add(String, Message) - Method in class org.openpreservation.odf.validation.ValidationReport
- add(Map<String, List<Message>>) - Method in interface org.openpreservation.messages.MessageLog
- addAll(Map<String, List<Message>>) - Method in class org.openpreservation.odf.validation.ValidationReport
- ANIM - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- Attribute - Interface in org.openpreservation.format.xml
-
An interface defining the behaviour of XML attributes.
C
- CHART - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
- CHART - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- check(OdfPackage) - Method in interface org.openpreservation.odf.validation.Profile
- check(OdfPackage) - Method in interface org.openpreservation.odf.validation.Rule
- check(OdfPackage) - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
- check(OdfXmlDocument) - Method in interface org.openpreservation.odf.validation.Profile
- check(OdfXmlDocument) - Method in interface org.openpreservation.odf.validation.Rule
- check(OdfXmlDocument) - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
- Checks - Class in org.openpreservation.utils
- COL_ERR - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
- COL_GREEN - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
- COL_INFO - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
- COL_RED - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
- COL_WARN - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
- COL_YELLOW - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
- colourise(String, String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
- colourise(Path, Message) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
- colourise(Path, Message, String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
- colourise(Message) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
- colourise(Message, String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
- CONFIG - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- ConsoleFormatter - Enum Class in org.openpreservation.odf.apps
- Constants - Class in org.openpreservation.odf.fmt
- Constants - Class in org.openpreservation.odf.pkg
- Constants - Class in org.openpreservation.odf.xml
D
- DATABASE - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
- DB - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- DEFAULT_MESSAGE - Static variable in enum class org.openpreservation.messages.Messages
- description - Variable in enum class org.openpreservation.odf.xml.Namespaces
- document - Variable in class org.openpreservation.odf.validation.ValidationReport
- documentMessages - Variable in class org.openpreservation.odf.validation.ValidationReport
- Documents - Class in org.openpreservation.odf.document
- DocumentType - Enum Class in org.openpreservation.odf.xml
- DR3D - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- DRAW - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- DRAWING - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
- DS - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- DSIG - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
E
- EmbeddedObjectsRule - Class in org.openpreservation.odf.validation.rules
- EMPTY_MESSAGE - Static variable in enum class org.openpreservation.messages.Messages
- encoding - Variable in enum class org.openpreservation.format.xml.Encodings
-
The
String
encoding name for the Byte Order Mark - Encodings - Enum Class in org.openpreservation.format.xml
-
An enum defining the Byte Order Marks for UTF-8, UTF-16 and UTF-32.
- equals(Object) - Method in class org.openpreservation.format.zip.ZipEntryImpl
- equals(Object) - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
- equals(Object) - Method in class org.openpreservation.odf.validation.ValidationReport
- error(String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
- error(SAXParseException) - Method in class org.openpreservation.format.xml.MessageHandler
- ERROR - Enum constant in enum class org.openpreservation.messages.Message.Severity
-
The message is an error, equivalent to MUST
- extension - Variable in enum class org.openpreservation.odf.fmt.Formats
-
The String extension associated with the MIME type
- extractorInstance(Path, boolean) - Static method in class org.openpreservation.format.zip.Zips
-
Create a
ZipEntryProcessor
instance that processes the entries and extracts them to the supplied rootPath
.
F
- factoryInstance() - Static method in class org.openpreservation.format.zip.Zips
-
Create a
ZipProcessor.Factory
instance that can be used to createZipProcessor
instances. - FATAL - Enum constant in enum class org.openpreservation.messages.Message.Severity
-
The message is a fatal error, usually an system issue
- fatalError(SAXParseException) - Method in class org.openpreservation.format.xml.MessageHandler
- FileEntry - Interface in org.openpreservation.odf.pkg
- FileType - Enum Class in org.openpreservation.odf.document
- FO - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- FORM - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- Formats - Enum Class in org.openpreservation.odf.fmt
- FormatSniffer - Class in org.openpreservation.odf.fmt
- FORMULA - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
- from(ZipEntryProcessor) - Method in interface org.openpreservation.format.zip.ZipProcessor.Factory
-
Factory for creating a
ZipProcessor
from aZipEntryProcessor
. - fromEncoding(String) - Static method in enum class org.openpreservation.format.xml.Encodings
-
Get an
Encodings
instance from the String name orEncodings.NONE
if no match - fromExtension(String) - Static method in enum class org.openpreservation.odf.fmt.Formats
- fromId(String) - Static method in enum class org.openpreservation.odf.xml.Namespaces
- fromId(URI) - Static method in enum class org.openpreservation.odf.xml.Namespaces
- fromMime(String) - Static method in enum class org.openpreservation.odf.fmt.Formats
- fromPrefix(String) - Static method in enum class org.openpreservation.odf.xml.Namespaces
- fromRepresentation(byte[]) - Static method in enum class org.openpreservation.format.xml.Encodings
-
Get an
Encodings
instance from the byte array representation, orEncodings.NONE
if no match. - fromVersion(String) - Static method in enum class org.openpreservation.odf.xml.Version
G
- getBodyElementName() - Method in enum class org.openpreservation.odf.xml.DocumentType
- getBytes() - Method in enum class org.openpreservation.odf.fmt.Formats
-
Get the MIME type as an ASCII encoded byte array.
- getCachedEntryNames() - Method in interface org.openpreservation.format.zip.ZipArchiveCache
-
Get a
List
of all of the cached entries in the archive - getCachedEntryNames() - Method in class org.openpreservation.format.zip.ZipFileProcessor
- getCompressedSize() - Method in interface org.openpreservation.format.zip.ZipEntry
-
Get the compressed size of the entry in bytes
- getCompressedSize() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- getCrc() - Method in interface org.openpreservation.format.zip.ZipEntry
-
Get the CRC of the entry
- getCrc() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- getDescription() - Method in interface org.openpreservation.odf.validation.Profile
- getDescription() - Method in interface org.openpreservation.odf.validation.Rule
- getDescription() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
- getDetectedFormat() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the detected
Formats
of the package. - getDnaProfile() - Static method in class org.openpreservation.odf.validation.rules.Rules
- getDocument() - Method in interface org.openpreservation.odf.document.OpenDocument
-
Get the main ODF Document details, this will be the only document for a single XML file, a package may have sub-documents
- getDocument() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the
OdfPackageDocument
for the package, this is the root document of the ODF Package - getDocumentEntries() - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get the set of FileEntry objects that are documents, i.e.
- getDocumentMap() - Method in interface org.openpreservation.odf.pkg.OdfPackage
- getDocumentType() - Method in interface org.openpreservation.odf.document.OdfDocument
-
Gets the parsed type of the ODF document.
- getEncryptedEntries() - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get the Set of FileEntry objects fior all manifest entries with encryption XML data.
- getEntries() - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get the Set of FileEntry objects in the Manifest.
- getEntriesByMediaType(String) - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get the Set of FileEntry objects in the Manifest that have the supplied media type.
- getEntry(String) - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get a manifest entry by name
- getEntryCount() - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get the number of entries in the Manifest.
- getEntryInputStream(String) - Method in interface org.openpreservation.format.zip.ZipArchiveCache
-
Get the
InputStream
for the entry with the passed name, equivalent to the path. - getEntryInputStream(String) - Method in class org.openpreservation.format.zip.ZipFileProcessor
- getEntryMediaType(String) - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get a manifest entry media type by name
- getEntryStream(FileEntry) - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the
InputStream
for any item from the document'sManifest
- getEntryXmlParseResult(String) - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the XML
ParseResult
of and identified ODF XML documents in the package - getEntryXmlStream(String) - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the
InputStream
to any of an identified ODF XML document in the package - getError(String) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve error
Message
by unique persistent id - getError(String, Object...) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve error Message by unique persistent id and format with the given arguments
- getErrorCount() - Method in interface org.openpreservation.messages.MessageLog
- getErrors() - Method in interface org.openpreservation.messages.MessageLog
- getErrors() - Method in class org.openpreservation.odf.validation.ValidationReport
- getExtra() - Method in interface org.openpreservation.format.zip.ZipEntry
-
Get the extra field data for the entry
- getExtra() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- getFatal(String) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve fatal Message by unique persistent id
- getFatal(String, Object...) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve error Message by unique persistent id and format with the given arguments
- getFileEntry() - Method in interface org.openpreservation.odf.pkg.OdfPackageDocument
-
Returns the manifest file entry for the package document.
- getFileType() - Method in interface org.openpreservation.odf.document.OpenDocument
-
Indicates the type of OpenDocument, a zip archive package or a single XML file
- getFirstEntry() - Method in interface org.openpreservation.format.zip.ZipArchive
-
Returns the first physical
ZipEntry
in the archive. - getFirstEntry() - Method in class org.openpreservation.format.zip.ZipFileProcessor
-
Returns the first physical
ZipEntry
in the archive. - getFormat() - Method in interface org.openpreservation.odf.document.OpenDocument
-
Get the format of the OpenDocument, this will be the declared format of the package or the parsed format of a single document.
- getFormats() - Method in enum class org.openpreservation.odf.xml.DocumentType
- getFullPath() - Method in interface org.openpreservation.odf.pkg.FileEntry
-
Get the full internal path of the file entry.
- getId() - Method in interface org.openpreservation.format.xml.Namespace
-
Get the
URI
id of theNamespace
. - getId() - Method in interface org.openpreservation.messages.Message
-
Get the unique, persistent message identifier.
- getId() - Method in interface org.openpreservation.odf.validation.Profile
- getId() - Method in interface org.openpreservation.odf.validation.ProfileResult
- getId() - Method in interface org.openpreservation.odf.validation.Rule
- getId() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
- getIndex() - Method in interface org.openpreservation.format.xml.Attribute
-
Get the index of the
Attribute
in the elementArray
. - getInfo(String) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve info Message by unique persistent id
- getInfo(String, Object...) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve info Message by unique persistent id and format with the given arguments
- getInfoCount() - Method in interface org.openpreservation.messages.MessageLog
- getInfos() - Method in interface org.openpreservation.messages.MessageLog
- getInstance() - Static method in enum class org.openpreservation.messages.Messages
-
Get a MessageFactory instance with the default property based bundle name and the default user locale
- getInstance(String) - Static method in enum class org.openpreservation.messages.Messages
-
Get a MessageFactory instance with the requested property based bundle name and the default user locale
- getInstance(String, Locale) - Static method in enum class org.openpreservation.messages.Messages
-
Get a MessageFactory instance with the requested property based bundle name and a specific locale
- getLength() - Method in enum class org.openpreservation.format.xml.Encodings
-
Returns the length of the Byte Order Mark in bytes
- getLength() - Method in enum class org.openpreservation.odf.fmt.Signatures
- getLocalName() - Method in interface org.openpreservation.format.xml.Attribute
-
Get the
String
local name of theAttribute
. - getLocalRootName() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
-
Get the name of the local/unqualified of the document's root element.
- getManifest() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the
Manifest
object for the package, this is parsed as long as theMETA-INF/manifest.xml
file exists and is a well formed XML document. - getMaxSignatureLength() - Method in enum class org.openpreservation.odf.fmt.Formats
- getMediaType() - Method in interface org.openpreservation.odf.pkg.FileEntry
-
Get the declared media type of the file entry.
- getMessage() - Method in interface org.openpreservation.messages.Message
-
Get the main message
- getMessage(String, Message.Severity) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve
Message
by unique persistent id andSeverity
- getMessage(String, Message.Severity, Object...) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve Message by unique persistent id and format with the given arguments
- getMessageInstance(String) - Static method in enum class org.openpreservation.messages.Messages
-
Create a new message instance with a DEFAULT_ID
- getMessageInstance(String, Message.Severity, String) - Static method in enum class org.openpreservation.messages.Messages
-
Create a Message instance with the give id and message value
- getMessageInstance(String, Message.Severity, String, String) - Static method in enum class org.openpreservation.messages.Messages
-
Create a new Message instance with the given id, message and sub-message
- getMessages() - Method in interface org.openpreservation.format.xml.ParseResult
-
The
List
ofMessage
instances generated when parsing the document, which may be empty - getMessages() - Method in interface org.openpreservation.messages.MessageLog
- getMessages() - Method in class org.openpreservation.odf.validation.ValidationReport
- getMessagesById(String) - Method in interface org.openpreservation.messages.MessageLog
- getMessagesBySeverity(Message.Severity) - Method in interface org.openpreservation.messages.MessageLog
- getMessagesForPath(String) - Method in interface org.openpreservation.messages.MessageLog
- getMetadata() - Method in interface org.openpreservation.odf.document.OdfDocument
-
Gets the Metadata object parsed from the main ODF XML document for single file XML documents or from the meta.xml file for documents parsed from a package.
- getMetaInfMap() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Retrieve the
Map
ofString
path keys andParseResult
values for anyZipEntry
below theMETA-INF
directory. - getMethod() - Method in interface org.openpreservation.format.zip.ZipEntry
-
Get the integer code for the compression method used for the entry.
- getMethod() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- getMimeType() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the declared
mimetype
of the package. - getMimeType() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
-
Get the declared ODF MIME type of the document, parsed from a root element attribute
- getName() - Method in interface org.openpreservation.format.zip.ZipEntry
-
Get the name of the entry
- getName() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- getName() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the name or identifier of the package, often the path to the file parsed.
- getName() - Method in interface org.openpreservation.odf.validation.Profile
- getName() - Method in interface org.openpreservation.odf.validation.Rule
- getName() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
- getName() - Method in interface org.openpreservation.odf.xml.Metadata.UserDefinedField
-
Get the name of the user defined field.
- getNamespaces() - Method in interface org.openpreservation.format.xml.ParseResult
-
Get all of the declared
Namespace
s in the document - getNonValidatingFactory() - Static method in class org.openpreservation.format.xml.XmlParser
-
Convenience method to obtain a pre-configured SAXParserFactory that is not validating and is namespace aware.
- getPackage() - Method in interface org.openpreservation.odf.document.OpenDocument
-
Get the ODF Package for the OpenDocument, this will be null for a single XML file.
- getPackageParser() - Static method in class org.openpreservation.odf.pkg.OdfPackages
-
A factory method for
PackageParser
instances. - getParseResult() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
-
Get the parse result of the XML document
- getPrefix() - Method in interface org.openpreservation.format.xml.Attribute
-
Get the
String
namespace prefix of theAttribute
. - getPrefix() - Method in interface org.openpreservation.format.xml.Namespace
-
Get the
String
prefix of theNamespace
. - getProfileMessages() - Method in interface org.openpreservation.odf.validation.ProfileResult
- getQualifiedName() - Method in interface org.openpreservation.format.xml.Attribute
-
Get the qualified name of the
Attribute
. - getResult(boolean, List<Message>) - Method in class org.openpreservation.format.xml.ParsingHandler
- getRootAttributes() - Method in interface org.openpreservation.format.xml.ParseResult
-
Get the root element
Attribute
s - getRootAttributeValue(String) - Method in interface org.openpreservation.format.xml.ParseResult
-
Get the value of the root element attribute with the supplied qualified name.
- getRootMediaType() - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get the declared media type of the Manifest from the root "/" element.
- getRootName() - Method in interface org.openpreservation.format.xml.ParseResult
-
Get the unqualified name of the document's root element
- getRootName() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
-
Get the namespace prefixed/qualfied name of the document's root element.
- getRootNamespace() - Method in interface org.openpreservation.format.xml.ParseResult
-
Get the
Namespace
associated with the document's root element - getRootNamespace() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
-
Get the default namespace associated with the root element of the document
- getRootPrefix() - Method in interface org.openpreservation.format.xml.ParseResult
-
Get the root element namespace prefix
- getRootVersion() - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get the declared version of the ODF package from the root "/" element.
- getRules() - Method in interface org.openpreservation.odf.validation.Profile
- getSchema(Namespaces) - Method in class org.openpreservation.odf.xml.OdfSchemaFactory
- getSchema(Namespaces, Version) - Method in class org.openpreservation.odf.xml.OdfSchemaFactory
- getSchemalocation() - Method in interface org.openpreservation.format.xml.Namespace
-
Get the
String
location of theNamespace
. - getSchemas(Set<Namespaces>, Version) - Method in class org.openpreservation.odf.xml.OdfSchemaFactory
- getSeverity() - Method in interface org.openpreservation.messages.Message
-
Get the message severity
- getSeverity() - Method in interface org.openpreservation.odf.validation.Rule
- getSeverity() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
- getSignature() - Method in enum class org.openpreservation.odf.fmt.Signatures
- getSignatureCount() - Method in enum class org.openpreservation.odf.fmt.Formats
- getSize() - Method in interface org.openpreservation.format.zip.ZipEntry
-
Get the size of the entry in bytes
- getSize() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- getSize() - Method in interface org.openpreservation.odf.pkg.FileEntry
-
The size of the file entry in bytes.
- getStringValue(String) - Method in interface org.openpreservation.odf.xml.Metadata
-
Get the String value for the supplied qualified name.
- getStringValue(String, String) - Method in interface org.openpreservation.odf.xml.Metadata
-
Look up the string value by prefix and local name.
- getStringValueMap() - Method in interface org.openpreservation.odf.xml.Metadata
-
The qualified Name value Map of all of the qualifiedName:string pairs found in the metadata block.
- getSubDocument(String) - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get an
OdfPackageDocument
for a sub-document identified by the passedString
path. - getSubDocuments() - Method in interface org.openpreservation.odf.document.OpenDocument
-
For and ODF Package get the sub-documents, these will be the documents in the package other than the main document.
- getSubMessage() - Method in interface org.openpreservation.messages.Message
-
Get the sub-message
- getTimestamp() - Method in interface org.openpreservation.messages.Message
-
Get the message timestamp
- getType() - Method in interface org.openpreservation.format.xml.Attribute
-
Get the
String
type of theAttribute
. - getTypeByBodyElement(String) - Static method in enum class org.openpreservation.odf.xml.DocumentType
- getTypeByFormat(Formats) - Static method in enum class org.openpreservation.odf.xml.DocumentType
- getTypeByMimeString(String) - Static method in enum class org.openpreservation.odf.xml.DocumentType
- getURI() - Method in interface org.openpreservation.format.xml.Attribute
-
Get the
String
namespace URI of theAttribute
. - getUserDefinedFields() - Method in interface org.openpreservation.odf.xml.Metadata
-
Get the user defined fields from the metadata block
- getValidatingParser() - Static method in class org.openpreservation.odf.validation.Validators
-
Get a validating parser instance.
- getValidationReport() - Method in interface org.openpreservation.odf.validation.ProfileResult
- getValue() - Method in interface org.openpreservation.format.xml.Attribute
-
Get the
String
value of theAttribute
. - getValue() - Method in interface org.openpreservation.odf.xml.Metadata.UserDefinedField
-
The String representation of the user defined field's value.
- getValueType() - Method in interface org.openpreservation.odf.xml.Metadata.UserDefinedField
-
The defined data type of the user defined field's value.
- getVersion() - Method in interface org.openpreservation.odf.document.OdfDocument
-
Gets the version of the ODF document
- getVersion() - Method in interface org.openpreservation.odf.pkg.FileEntry
-
Get's the version of the file entry if it's declared.
- getVersion() - Method in interface org.openpreservation.odf.pkg.Manifest
-
Get the declared version of the Manifest from the root element.
- getVersion() - Method in interface org.openpreservation.odf.xml.Metadata
-
Return the office version of the Metadata data.
- getVersion() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
-
Get the ODF version of the XML document, parsed from a root element attribute
- getWarning(String) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve warning Message by unique persistent id
- getWarning(String, Object...) - Method in interface org.openpreservation.messages.MessageFactory
-
Retrieve warning Message by unique persistent id and format with the given arguments
- getWarningCount() - Method in interface org.openpreservation.messages.MessageLog
- getWarnings() - Method in interface org.openpreservation.messages.MessageLog
- getXmlDocument() - Method in interface org.openpreservation.odf.document.OdfDocument
-
Returns the ODF Xml Document instance with the details of the parsed document.
- getXmlDocument(String) - Method in interface org.openpreservation.odf.pkg.OdfPackageDocument
-
Returns the XML document for the supplied path.
- getXmlDocumentMap() - Method in interface org.openpreservation.odf.pkg.OdfPackageDocument
-
Returns the map of all XML documents in the package document.
- getXmlEntries() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the
Set
ofFileEntry
to all of the identified ODF XML documents in the package. - getXmlEntryPaths() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get a
List
paths of the package's identified ODF XML documents. - getZipArchive() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Returns the details of the underlying
ZipArchive
for the package. - getZipEntries() - Method in interface org.openpreservation.format.zip.ZipArchive
-
Get a
List
of all of the zip entries in the archive - getZipEntries() - Method in class org.openpreservation.format.zip.ZipFileProcessor
- getZipEntry(String) - Method in interface org.openpreservation.format.zip.ZipArchive
-
Retrieve a
ZipEntry
by entry name, equivalent to the path. - getZipEntry(String) - Method in class org.openpreservation.format.zip.ZipFileProcessor
- GRDDL - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- GREATER_THAN_OR_EQUAL_TO - Static variable in class org.openpreservation.utils.Checks
H
- hasDsigEntries() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Does the META-INF directory or sub-directories contain a
ZipeEntry
with the term "signatures" in its name. - hasErrors() - Method in interface org.openpreservation.messages.MessageLog
- hashCode() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- hashCode() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
- hashCode() - Method in class org.openpreservation.odf.validation.ValidationReport
- hasInfos() - Method in interface org.openpreservation.messages.MessageLog
- hasManifest() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Does the package have a manifest, that is a
ZipEntry
with the pathMETA-INF/manifest.xml
? - hasMimeEntry() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Does the package have a
mimetype
ZipEntry
? - hasMimeType() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
-
Does the document declare a MIME type?
- hasRootMediaType() - Method in interface org.openpreservation.odf.pkg.Manifest
-
Find out whether the manifest has a FileEntry with the full path attribute "/".
- hasSubMessage() - Method in interface org.openpreservation.messages.Message
-
Test whether the message has a sub-message
- hasThumbnail() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Does the package have a
ZipEntry
with the pathThumbnails/thumbnail.png
? - hasVersion() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
-
Does the document declare a version?
- hasWarnings() - Method in interface org.openpreservation.messages.MessageLog
I
- id - Variable in enum class org.openpreservation.odf.xml.Namespaces
- identify(byte[]) - Static method in enum class org.openpreservation.odf.fmt.Formats
- IMAGE - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
- info(String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
- INFO - Enum constant in enum class org.openpreservation.messages.Message.Severity
-
The message is informational, equivalent to MAY
- INSTANCE - Enum constant in enum class org.openpreservation.messages.Messages
-
Ensure Messages is a singleton
- INSTANCE - Enum constant in enum class org.openpreservation.odf.apps.ConsoleFormatter
- isCompressionValid(ZipEntry) - Static method in class org.openpreservation.odf.validation.Validators
-
Check if a zip entry has a valid compression method.
- isDirectory() - Method in interface org.openpreservation.format.zip.ZipEntry
-
Is the entry a directory?
- isDirectory() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- isDocument() - Method in interface org.openpreservation.odf.pkg.FileEntry
-
Is the file entry a document entry?
- isDsig(String) - Static method in class org.openpreservation.odf.pkg.OdfPackages
-
Check if the given
String
is an ODF spec compliant Digital Signature path. - isEmpty() - Method in interface org.openpreservation.messages.MessageLog
-
Is the log empty?
- isEncrypted() - Method in interface org.openpreservation.odf.pkg.FileEntry
-
Is the file entry encrypted?
- isError() - Method in interface org.openpreservation.messages.Message
-
Test whether the message has
Message.Severity
ERROR. - isFatal() - Method in interface org.openpreservation.messages.Message
-
Test whether the message has
Message.Severity
FATAL. - isInfo() - Method in interface org.openpreservation.messages.Message
-
Test whether the message has
Message.Severity
INFO. - isMatch(byte[]) - Method in enum class org.openpreservation.odf.fmt.Signatures
- isMatch(byte[], int) - Method in enum class org.openpreservation.odf.fmt.Signatures
- isMimeFirst() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Is the
mimetype
ZipEntry
the firstZipEntry
in the package? - isOdf() - Method in enum class org.openpreservation.odf.fmt.Formats
- isOdfXml(String) - Static method in class org.openpreservation.odf.pkg.OdfPackages
-
Check if the passed
String
path is an ODF specified XML file name. - isPackage() - Method in interface org.openpreservation.odf.document.OpenDocument
-
Is the OpenDocument an ODF package, i.e.
- isPackage() - Method in enum class org.openpreservation.odf.fmt.Formats
- isPackage(File) - Static method in class org.openpreservation.odf.fmt.OdfFormats
- isPackage(InputStream) - Static method in class org.openpreservation.odf.fmt.OdfFormats
- isPackage(String) - Static method in class org.openpreservation.odf.fmt.OdfFormats
- isPackage(Path) - Static method in class org.openpreservation.odf.fmt.OdfFormats
- isPrerequisite() - Method in interface org.openpreservation.odf.validation.Rule
- isPrerequisite() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
- isRootName(String) - Method in interface org.openpreservation.format.xml.ParseResult
-
Establish whether the document's root element name matches the supplied name
- isStored() - Method in interface org.openpreservation.format.zip.ZipEntry
-
Is the entry
STORED
, e.g. - isStored() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- isText() - Method in enum class org.openpreservation.odf.fmt.Formats
- isValid() - Method in interface org.openpreservation.format.xml.ValidationResult
-
Is the XML document valid according to the supplied schema?
- isValid() - Method in interface org.openpreservation.odf.validation.ProfileResult
- isValid() - Method in class org.openpreservation.odf.validation.ValidationReport
- isValidZip(Path) - Static method in class org.openpreservation.odf.pkg.OdfPackages
-
Check if the supplied
Path
resolves to a valid zip archive instance. - isWarning() - Method in interface org.openpreservation.messages.Message
-
Test whether the message has
Message.Severity
WARNING. - isWellFormed() - Method in interface org.openpreservation.format.xml.ParseResult
-
Is the XML document well formed?
- isWellFormedZip() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Is the item parsed a well formed
ZipArchive
. - isXml(File) - Static method in class org.openpreservation.odf.fmt.OdfFormats
- isXml(InputStream) - Static method in class org.openpreservation.odf.fmt.OdfFormats
- isXml(String) - Static method in class org.openpreservation.odf.fmt.OdfFormats
- isXml(Path) - Static method in class org.openpreservation.odf.fmt.OdfFormats
- isXml(Path) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
-
Determines whether the supplied path is an XML document or not.
- isZip(Path) - Static method in class org.openpreservation.odf.pkg.OdfPackages
-
Uses the
FormatSniffer
to see if the supplied path resolves to a ZIP instance.
L
- label - Variable in enum class org.openpreservation.messages.Message.Severity
-
The label for the severity, lower case
M
- Manifest - Interface in org.openpreservation.odf.pkg
- MANIFEST - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- match(byte[]) - Static method in enum class org.openpreservation.odf.fmt.Signatures
- match(byte[], int) - Static method in enum class org.openpreservation.odf.fmt.Signatures
- match(byte[], int, Collection<Signatures>) - Static method in enum class org.openpreservation.odf.fmt.Signatures
- matchAll(byte[]) - Static method in enum class org.openpreservation.odf.fmt.Signatures
- matchAll(byte[], int) - Static method in enum class org.openpreservation.odf.fmt.Signatures
- MAX_LENGTH - Static variable in enum class org.openpreservation.odf.fmt.Signatures
- Message - Interface in org.openpreservation.messages
-
Defines behaviour of validation messages.
- Message.Severity - Enum Class in org.openpreservation.messages
-
An enum set that defines the severity of a message.
- MessageFactory - Interface in org.openpreservation.messages
-
Factory interface for
Message
creation - MessageHandler - Class in org.openpreservation.format.xml
- MessageHandler() - Constructor for class org.openpreservation.format.xml.MessageHandler
- MessageHandler(String) - Constructor for class org.openpreservation.format.xml.MessageHandler
- MessageLog - Interface in org.openpreservation.messages
-
Interface for a log of
Message
objects. - messageLogInstance() - Static method in enum class org.openpreservation.messages.Messages
- messageLogInstance(String, List<Message>) - Static method in enum class org.openpreservation.messages.Messages
- messages - Variable in class org.openpreservation.format.xml.MessageHandler
- Messages - Enum Class in org.openpreservation.messages
-
Utility class that handles creation of Message type instances, etc.
- META - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- Metadata - Interface in org.openpreservation.odf.xml
-
Interface for retrieving any useful metadata from an ODF package meta.xml file.
- Metadata.UserDefinedField - Interface in org.openpreservation.odf.xml
-
Interface that handles basic user defined field information.
- metadataFrom(InputStream) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
-
Instantiates a Metadata object from an InputStream.
- metadataOf(String, Map<String, String>, List<Metadata.UserDefinedField>) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
-
Instantiates a Metadata object from a version string, a Map of string values, and a List of UserDefinedFields.
- mime - Variable in enum class org.openpreservation.odf.fmt.Formats
-
The String MIME type identifier
- MIME_UKNOWN - Static variable in class org.openpreservation.odf.fmt.OdfFormats
- MIMETYPE - Static variable in class org.openpreservation.odf.fmt.OdfFormats
- MIMETYPE - Static variable in class org.openpreservation.odf.pkg.OdfPackages
-
The ODF specified name of the mimetype zip entry.
N
- NAME_META_INF - Static variable in class org.openpreservation.odf.pkg.OdfPackages
-
The ODF specified name of the package META-INF directory.
- Namespace - Interface in org.openpreservation.format.xml
-
An interface defining the properties of XML namespaces.
- Namespaces - Enum Class in org.openpreservation.odf.xml
- newline() - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
- NO_ID - Static variable in enum class org.openpreservation.messages.Messages
- NOMATCH - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- NONE - Enum constant in enum class org.openpreservation.format.xml.Encodings
-
Empty Byte String to match no encoding
- NOT_EMPTY - Static variable in class org.openpreservation.utils.Checks
- NOT_NULL - Static variable in class org.openpreservation.utils.Checks
- NUMBER - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
O
- ODB - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ODB - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ODC - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ODC - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ODF - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ODF - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ODF - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- ODF_10 - Enum constant in enum class org.openpreservation.odf.xml.Version
- ODF_11 - Enum constant in enum class org.openpreservation.odf.xml.Version
- ODF_12 - Enum constant in enum class org.openpreservation.odf.xml.Version
- ODF_13 - Enum constant in enum class org.openpreservation.odf.xml.Version
- ODF_MIME - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- odf1() - Static method in class org.openpreservation.odf.validation.rules.Rules
- odf10() - Static method in class org.openpreservation.odf.validation.rules.Rules
- odf2() - Static method in class org.openpreservation.odf.validation.rules.Rules
- odf3() - Static method in class org.openpreservation.odf.validation.rules.Rules
- odf4() - Static method in class org.openpreservation.odf.validation.rules.Rules
- odf5() - Static method in class org.openpreservation.odf.validation.rules.Rules
- odf6() - Static method in class org.openpreservation.odf.validation.rules.Rules
- odf7() - Static method in class org.openpreservation.odf.validation.rules.Rules
- odf8() - Static method in class org.openpreservation.odf.validation.rules.Rules
- odf9() - Static method in class org.openpreservation.odf.validation.rules.Rules
- OdfDocument - Interface in org.openpreservation.odf.document
- odfDocumentOf(ParseResult) - Static method in class org.openpreservation.odf.document.Documents
- odfDocumentOf(ParseResult, Metadata) - Static method in class org.openpreservation.odf.document.Documents
- odfDocumentOf(OdfXmlDocument, Metadata) - Static method in class org.openpreservation.odf.document.Documents
- OdfFormats - Class in org.openpreservation.odf.fmt
- OdfPackage - Interface in org.openpreservation.odf.pkg
-
An interface defining the behaviour of ODF packages.
- OdfPackageDocument - Interface in org.openpreservation.odf.pkg
- OdfPackages - Class in org.openpreservation.odf.pkg
-
A static utility class for general ODF package parsing.
- OdfSchemaFactory - Class in org.openpreservation.odf.xml
- OdfSchemaFactory() - Constructor for class org.openpreservation.odf.xml.OdfSchemaFactory
- OdfXmlDocument - Interface in org.openpreservation.odf.xml
- odfXmlDocumentOf(ParseResult) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
-
Instantiates an OdfXmlDocument from an XML ParseResult
- OdfXmlDocuments - Class in org.openpreservation.odf.xml
- ODG - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ODG - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ODI - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ODI - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ODM - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ODM - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ODP - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ODP - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ODS - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ODS - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ODT - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ODT - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- of(ParseResult, boolean, List<Message>) - Static method in class org.openpreservation.format.xml.ValidationResults
-
Creates a new
ValidationResult
object from the supplied values. - OFFICE - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- offset - Variable in enum class org.openpreservation.odf.fmt.Signatures
- OpenDocument - Interface in org.openpreservation.odf.document
- openDocumentOf(OdfDocument) - Static method in class org.openpreservation.odf.document.Documents
- openDocumentOf(OdfPackage) - Static method in class org.openpreservation.odf.document.Documents
- org.openpreservation.format.xml - package org.openpreservation.format.xml
- org.openpreservation.format.zip - package org.openpreservation.format.zip
- org.openpreservation.messages - package org.openpreservation.messages
- org.openpreservation.odf.apps - package org.openpreservation.odf.apps
- org.openpreservation.odf.apps.pkg - package org.openpreservation.odf.apps.pkg
- org.openpreservation.odf.document - package org.openpreservation.odf.document
- org.openpreservation.odf.fmt - package org.openpreservation.odf.fmt
- org.openpreservation.odf.pkg - package org.openpreservation.odf.pkg
- org.openpreservation.odf.validation - package org.openpreservation.odf.validation
- org.openpreservation.odf.validation.rules - package org.openpreservation.odf.validation.rules
- org.openpreservation.odf.xml - package org.openpreservation.odf.xml
- org.openpreservation.utils - package org.openpreservation.utils
- OTC - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- OTC - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- OTF - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- OTF - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- OTG - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- OTG - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- OTH - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- OTH - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- OTI - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- OTI - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- OTM - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- OTM - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- OTP - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- OTP - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- OTS - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- OTS - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- OTT - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- OTT - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
P
- PACKAGE - Enum constant in enum class org.openpreservation.odf.document.FileType
- PackageParser - Interface in org.openpreservation.odf.pkg
-
An interface defining the behaviour of ODF package parsers.
- parse(InputStream) - Method in class org.openpreservation.format.xml.XmlParser
-
Parses the supplied
InputStream
for well-formedness and returns aParseResult
object. - parse(Path) - Method in class org.openpreservation.format.xml.XmlParser
-
Parses the supplied
Path
for well-formedness and returns aParseResult
object. - parsePackage(File) - Method in interface org.openpreservation.odf.pkg.PackageParser
-
Parse a Java File instance and return an
OdfPackage
instance. - parsePackage(InputStream, String) - Method in interface org.openpreservation.odf.pkg.PackageParser
-
Parse an
InputStream
and return anOdfPackage
instance. - parsePackage(Path) - Method in interface org.openpreservation.odf.pkg.PackageParser
-
Resove and parse a system
Path
and return anOdfPackage
instance. - ParseResult - Interface in org.openpreservation.format.xml
-
An interface defining the properties of XML document parsing results.
- parseResultOf(boolean, Namespace, List<Namespace>, String, String, List<Attribute>, List<Message>) - Static method in class org.openpreservation.format.xml.ValidationResults
-
Create a new
ParseResult
object from the supplied values. - ParsingHandler - Class in org.openpreservation.format.xml
- ParsingHandler() - Constructor for class org.openpreservation.format.xml.ParsingHandler
- PATH_MANIFEST - Static variable in class org.openpreservation.odf.pkg.OdfPackages
-
The ODF specified path to the package manifest.
- PATH_THUMBNAIL - Static variable in class org.openpreservation.odf.pkg.OdfPackages
-
The ODF specified path to a PNG thumbnail file.
- PKG - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- prefix - Variable in enum class org.openpreservation.odf.xml.Namespaces
- PRESENTATION - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
- PRESENTATION - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- process(InputStream) - Method in interface org.openpreservation.format.zip.ZipProcessor
-
Process the
InputStream
and return aZipArchive
containing parsed from the stream. - process(ZipEntry, InputStream) - Method in interface org.openpreservation.format.zip.ZipEntryProcessor
-
Process the
ZipEntry
and it'sInputStream
. - Profile - Interface in org.openpreservation.odf.validation
- ProfileResult - Interface in org.openpreservation.odf.validation
R
- Rule - Interface in org.openpreservation.odf.validation
- Rules - Class in org.openpreservation.odf.validation.rules
S
- SCRIPT - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- Signatures - Enum Class in org.openpreservation.odf.fmt
- SINGLE - Enum constant in enum class org.openpreservation.odf.document.FileType
- size() - Method in interface org.openpreservation.format.zip.ZipArchive
-
Get the count of entries in the archive
- size() - Method in class org.openpreservation.format.zip.ZipFileProcessor
- size() - Method in interface org.openpreservation.messages.MessageLog
-
Get the number of messages in the log.
- sniff(BufferedInputStream) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniff(BufferedInputStream, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniff(File) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniff(File, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniff(String) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniff(String, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniff(Path) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniff(Path, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniffEncoding(File) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniffEncoding(InputStream) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniffEncoding(String) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- sniffEncoding(Path) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
- SPREADSHEET - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
- startElement(String, String, String, Attributes) - Method in class org.openpreservation.format.xml.ParsingHandler
- startPrefixMapping(String, String) - Method in class org.openpreservation.format.xml.ParsingHandler
- STYLE - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
T
- TABLE - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- TEXT - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
- TEXT - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- toString() - Method in class org.openpreservation.format.zip.ZipEntryImpl
- toString() - Method in class org.openpreservation.odf.validation.ValidationReport
U
- UNKNOWN - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- UTF_16_BE - Enum constant in enum class org.openpreservation.format.xml.Encodings
-
UTF-16 Big Endian Byte Order Mark
- UTF_16_LE - Enum constant in enum class org.openpreservation.format.xml.Encodings
-
UTF-16 Little Endian Byte Order Mark
- UTF_32_BE - Enum constant in enum class org.openpreservation.format.xml.Encodings
-
UTF-32 Big Endian Byte Order Mark
- UTF_32_LE - Enum constant in enum class org.openpreservation.format.xml.Encodings
-
UTF-32 Little Endian Byte Order Mark
- UTF_8 - Enum constant in enum class org.openpreservation.format.xml.Encodings
-
UTF-8 Byte Order Mark
- Utils - Class in org.openpreservation.odf.fmt
V
- validate(File) - Method in class org.openpreservation.odf.validation.Validator
- validate(Path) - Method in class org.openpreservation.odf.validation.Validator
- validate(ParseResult, InputStream, Schema) - Method in class org.openpreservation.format.xml.XmlValidator
-
Validate the supplied InputStream against the supplied schema.
- validatePackage(OdfPackage) - Method in interface org.openpreservation.odf.validation.ValidatingParser
-
Validates the given ODF package.
- validateSingleFormat(File, Formats) - Method in class org.openpreservation.odf.validation.Validator
- validateSingleFormat(Path, Formats) - Method in class org.openpreservation.odf.validation.Validator
- validateSpreadsheet(File) - Method in class org.openpreservation.odf.validation.Validator
- validateSpreadsheet(Path) - Method in class org.openpreservation.odf.validation.Validator
- ValidatingParser - Interface in org.openpreservation.odf.validation
- ValidationReport - Class in org.openpreservation.odf.validation
- ValidationResult - Interface in org.openpreservation.format.xml
-
Simple extension of
ParseResult
to indicate whether the result of XML validation is valid or not. - ValidationResults - Class in org.openpreservation.format.xml
-
A factory for creating
ParseResult
andValidationResult
objects. - Validator - Class in org.openpreservation.odf.validation
- Validator() - Constructor for class org.openpreservation.odf.validation.Validator
- Validators - Class in org.openpreservation.odf.validation
- valueOf(String) - Static method in enum class org.openpreservation.format.xml.Encodings
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.openpreservation.messages.Message.Severity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.openpreservation.messages.Messages
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.openpreservation.odf.document.FileType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.openpreservation.odf.fmt.Formats
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.openpreservation.odf.fmt.Signatures
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.openpreservation.odf.xml.DocumentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.openpreservation.odf.xml.Namespaces
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.openpreservation.odf.xml.Version
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.openpreservation.format.xml.Encodings
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.openpreservation.messages.Message.Severity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.openpreservation.messages.Messages
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.openpreservation.odf.document.FileType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.openpreservation.odf.fmt.Formats
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.openpreservation.odf.fmt.Signatures
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.openpreservation.odf.xml.DocumentType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.openpreservation.odf.xml.Namespaces
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.openpreservation.odf.xml.Version
-
Returns an array containing the constants of this enum class, in the order they are declared.
- Version - Enum Class in org.openpreservation.odf.xml
W
- warn(String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
- warning(SAXParseException) - Method in class org.openpreservation.format.xml.MessageHandler
- WARNING - Enum constant in enum class org.openpreservation.messages.Message.Severity
-
The message is a warning, equivalent to SHOULD
X
- XFORMS - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- XHTML - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- XLINK - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- XML - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- XML_UTF_16_BE - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- XML_UTF_16_LE - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- XML_UTF_32_BE - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- XML_UTF_32_LE - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- XML_UTF_8 - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- xmlDocumentFrom(InputStream) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
-
Instatiates an OdfXmlDocument from an InputStream.
- XMLNS - Enum constant in enum class org.openpreservation.odf.xml.Namespaces
- XmlParser - Class in org.openpreservation.format.xml
-
Class to wrap the checking of XML files for well-formedness and validity.
- XmlParser() - Constructor for class org.openpreservation.format.xml.XmlParser
-
Default constructor for the
XmlParser
class. - XmlValidator - Class in org.openpreservation.format.xml
-
Simple class to wrap XML schema vaidaton.
- XmlValidator() - Constructor for class org.openpreservation.format.xml.XmlValidator
Z
- ZIP - Enum constant in enum class org.openpreservation.odf.fmt.Formats
- ZIP - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ZIP_EMPTY - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ZIP_SPANNED - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
- ZipArchive - Interface in org.openpreservation.format.zip
-
An interface for accessing the contents of a Zip archive.
- ZipArchiveCache - Interface in org.openpreservation.format.zip
-
An extension of
ZipArchive
that caches the contents of the archive and provides access to theInputStream
s. - zipArchiveCacheInstance(File) - Static method in class org.openpreservation.format.zip.Zips
-
Create a
ZipArchiveCache
instance that caches the contents of the archive and provides access to theInputStream
s. - zipArchiveCacheInstance(Path) - Static method in class org.openpreservation.format.zip.Zips
-
Create a
ZipArchiveCache
instance that caches the contents of the archive and provides access to thePath
s. - zipArchiveCacheInstance(ZipArchive, Map<String, byte[]>) - Static method in class org.openpreservation.format.zip.Zips
-
Create a
ZipArchiveCache
instance that caches the contents of the archive and provides access to theInputStream
s. - ZipEntry - Interface in org.openpreservation.format.zip
-
An interface for recording and accessing the properties of an entry from a
ZipArchive
. - ZipEntryImpl - Class in org.openpreservation.format.zip
- zipEntryInstance(String, int, int, int, int, boolean, byte[]) - Static method in class org.openpreservation.format.zip.Zips
- ZipEntryProcessor - Interface in org.openpreservation.format.zip
-
Interface for processing
ZipEntry
objects from aZipArchive
- ZipFileProcessor - Class in org.openpreservation.format.zip
-
An implementation of
ZipArchiveCache
that caches the contents of the archive and provides access to theInputStream
s. - ZipProcessor - Interface in org.openpreservation.format.zip
-
Interface for a processor that processes an
InputStream
and a factory for the processor. - ZipProcessor.Factory - Interface in org.openpreservation.format.zip
-
Factory for creating a
ZipProcessor
. - Zips - Class in org.openpreservation.format.zip
-
Utility class for working with
ZipArchive
s.
All Classes and Interfaces|All Packages|Constant Field Values