|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.io.File org.daisy.zedval.engine.ZedFile org.daisy.zedval.engine.ManifestFile org.daisy.zedval.engine.XmlFile
An XmlFile
object represents a single XML document file
This class includes default, do-nothing methods to implement the SAX
ContentHandler
interface (The appropriate ones will be
overridden by the subclasses).
This class also implements the SAX EntityResolver
interface as
a way of substituting local DTDs for known, internet-based system
identifiers. It uses the org.daisy.util.xml.catalog.CatalogEntityResolver for
this purpose.
Each XMLfile is validated on parse; any validation errors are caught and stored in local hashsets for later retrieval by testprocessors.
Field Summary |
Fields inherited from class org.daisy.zedval.engine.ManifestFile |
MIME_JPEG, MIME_MP3, MIME_NCX, MIME_PACKAGE, MIME_PNG, MIME_RESOURCE, MIME_SMIL, MIME_SVG, MIME_TEXT, MIME_WAV, MIME_AAC |
Fields inherited from class java.io.File |
pathSeparator, pathSeparatorChar, separator, separatorChar |
Constructor Summary | |
XmlFile(java.lang.String fullPath,
java.lang.String id,
java.lang.String mimeType)
|
Method Summary | |
void |
characters(char[] ch,
int start,
int length)
|
void |
comment(char[] ch,
int start,
int length)
|
void |
endCDATA()
|
void |
endDocument()
|
void |
endDTD()
|
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName)
|
void |
endEntity(java.lang.String name)
|
void |
endPrefixMapping(java.lang.String prefix)
|
void |
error(org.xml.sax.SAXParseException e)
Handles errors thrown by SAX parser (meaning document is not valid internally) |
void |
fatalError(org.xml.sax.SAXParseException e)
Handles fatal errors thrown by SAX parser (meaning document is not well-formed) |
java.util.Collection |
getAllValidationErrors()
|
java.lang.String |
getDoctypeName()
Returns the name given in the DOCTYPE (if any) |
java.lang.String |
getDoctypePublicId()
Returns the public id given in the DOCTYPE (if any) |
java.lang.String |
getDoctypeSystemId()
Returns the system id given in the DOCTYPE (if any) |
java.lang.String |
getRootElementLocalName()
|
java.lang.String |
getRootElementNsURI()
|
java.util.Collection |
getValidationErrors()
|
java.util.Collection |
getValidationFatalErrors()
|
java.util.Collection |
getValidationWarnings()
|
XmlFileElement |
getXmlFileElementById(java.lang.String idValue)
|
java.util.Collection |
getXmlFileElements()
|
boolean |
hasIDValue(java.lang.String idValue)
|
void |
ignorableWhitespace(char[] ch,
int start,
int length)
|
void |
initialize()
Does all basic integrity tests |
boolean |
isParsed()
Has this file been parsed? |
boolean |
isValid()
Is this file valid to the DTD? |
boolean |
isValidated()
Has this file been parsed with validation on? |
boolean |
isWellFormed()
Is this file well-formed XML? |
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
|
void |
processingInstruction(java.lang.String target,
java.lang.String data)
|
org.xml.sax.InputSource |
resolveEntity(java.lang.String publicId,
java.lang.String systemId)
|
void |
setDocumentLocator(org.xml.sax.Locator locator)
|
void |
skippedEntity(java.lang.String name)
|
void |
startCDATA()
|
void |
startDocument()
|
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
|
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes atts)
|
void |
startEntity(java.lang.String name)
|
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
|
java.lang.String |
toString()
|
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notationName)
|
void |
warning(org.xml.sax.SAXParseException e)
Handles warnings thrown by SAX parser |
Methods inherited from class org.daisy.zedval.engine.ManifestFile |
getId, getMimeType, getPackage, setID, setMimeType, setPackage |
Methods inherited from class org.daisy.zedval.engine.ZedFile |
getName |
Methods inherited from class java.io.File |
canRead, canWrite, compareTo, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getParent, getParentFile, getPath, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setLastModified, setReadOnly, toURI, toURL |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.daisy.zedval.engine.Referring |
getFileRefs |
Constructor Detail |
public XmlFile(java.lang.String fullPath, java.lang.String id, java.lang.String mimeType)
id
- id from package file manifestfullPath
- File pathmimeType
- File MIME type as given in package manifestMethod Detail |
public void initialize() throws ZedFileInitializationException
ZedFileInitializationException
public boolean isWellFormed()
true
if wellformed, false
if
malformed OR not yet parsedpublic boolean isValid()
true
if valid, false
if invalid OR
not yet parsed OR malformedpublic boolean isParsed()
true
if has been parsed, false
otherwisepublic boolean isValidated()
true
if has been parsed with validation on, false
otherwisepublic java.util.Collection getValidationErrors()
error
methodisValid()
public java.util.Collection getValidationFatalErrors()
fatalError
methodisWellFormed()
public java.util.Collection getValidationWarnings()
warning
methodpublic java.util.Collection getAllValidationErrors()
error
, fatalError
and warning
methodspublic java.lang.String getDoctypeName()
public java.lang.String getDoctypePublicId()
public java.lang.String getDoctypeSystemId()
public void characters(char[] ch, int start, int length)
characters
in interface org.xml.sax.ContentHandler
public void endDocument()
endDocument
in interface org.xml.sax.ContentHandler
public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
endElement
in interface org.xml.sax.ContentHandler
public void endPrefixMapping(java.lang.String prefix)
endPrefixMapping
in interface org.xml.sax.ContentHandler
public void ignorableWhitespace(char[] ch, int start, int length)
ignorableWhitespace
in interface org.xml.sax.ContentHandler
public void processingInstruction(java.lang.String target, java.lang.String data)
processingInstruction
in interface org.xml.sax.ContentHandler
public void setDocumentLocator(org.xml.sax.Locator locator)
setDocumentLocator
in interface org.xml.sax.ContentHandler
public void skippedEntity(java.lang.String name)
skippedEntity
in interface org.xml.sax.ContentHandler
public void startDocument()
startDocument
in interface org.xml.sax.ContentHandler
public void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
startElement
in interface org.xml.sax.ContentHandler
public void startPrefixMapping(java.lang.String prefix, java.lang.String uri)
startPrefixMapping
in interface org.xml.sax.ContentHandler
public void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
startDTD
in interface org.xml.sax.ext.LexicalHandler
public void comment(char[] ch, int start, int length)
comment
in interface org.xml.sax.ext.LexicalHandler
public void endCDATA()
endCDATA
in interface org.xml.sax.ext.LexicalHandler
public void endDTD()
endDTD
in interface org.xml.sax.ext.LexicalHandler
public void endEntity(java.lang.String name)
endEntity
in interface org.xml.sax.ext.LexicalHandler
public void startCDATA()
startCDATA
in interface org.xml.sax.ext.LexicalHandler
public void startEntity(java.lang.String name)
startEntity
in interface org.xml.sax.ext.LexicalHandler
public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException
notationDecl
in interface org.xml.sax.DTDHandler
org.xml.sax.SAXException
public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) throws org.xml.sax.SAXException
unparsedEntityDecl
in interface org.xml.sax.DTDHandler
org.xml.sax.SAXException
public void error(org.xml.sax.SAXParseException e)
error
in interface org.xml.sax.ErrorHandler
e
- The SAX exception thrownpublic void warning(org.xml.sax.SAXParseException e)
warning
in interface org.xml.sax.ErrorHandler
e
- The SAX exception thrownpublic void fatalError(org.xml.sax.SAXParseException e)
fatalError
in interface org.xml.sax.ErrorHandler
e
- The SAX exception thrownpublic org.xml.sax.InputSource resolveEntity(java.lang.String publicId, java.lang.String systemId)
resolveEntity
in interface org.xml.sax.EntityResolver
public java.lang.String toString()
toString
in class ManifestFile
public java.lang.String getRootElementLocalName()
public java.lang.String getRootElementNsURI()
public boolean hasIDValue(java.lang.String idValue)
idValue
- a string that may or may not be the value of an attribute named id in this XmlFile
public XmlFileElement getXmlFileElementById(java.lang.String idValue)
idValue
- a string that may or may not be the value of an attribute named id in this XmlFile
public java.util.Collection getXmlFileElements()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |