Package org.omegat.filters3.xml

Class Handler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.omegat.filters3.xml.Handler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, LexicalHandler

public class Handler
extends DefaultHandler
implements LexicalHandler, DeclHandler

The part of XML filter that actually does the job. This class is called back by SAXParser.

Entities described on Add entities in XML ENTITY Declaration

Constructor Summary

Constructors

Constructor	Description
Handler(Translator translator, XMLDialect dialect, File inFile, @Nullable File outFile, FilterContext fc)	Creates a new instance of Handler

Method Summary

Modifier and Type	Method	Description
void	attributeDecl(String eName, String aName, String type, String valueDefault, String value)	Not used: An attribute type declaration.
void	characters(char[] ch, int start, int length)	Receive notification of character data inside an element.
void	comment(char[] ch, int start, int length)	Receive notification of an XML comment anywhere in the document.
InputSource	doResolve(String publicId, String systemId)	Resolves an external entity and provides an InputSource for the entity.
void	elementDecl(String name, String model)	Not used: An element type declaration.
void	endCDATA()	Report the end of a CDATA section.
void	endDocument()	Receive notification of the end of the document.
void	endDTD()	Report the end of DTD declarations.
void	endElement(String uri, String localName, String qName)	Receive notification of the end of an element.
void	endEntity(String name)	Report the end of an entity.
void	externalEntityDecl(String name, String publicId, String systemId)	Report a parsed external entity declaration.
void	fatalError(SAXParseException e)	Report a fatal XML parsing error.
FilterContext	getContext()
@Nullable List<File>	getProcessedFiles()	Returns external files this handler has processed, because they were included into main file.
void	ignorableWhitespace(char[] ch, int start, int length)	Receive notification of ignorable whitespace in element content.
void	internalEntityDecl(String name, String value)	Report an internal entity declaration.
boolean	isParagraphTag(Tag tag)	Returns whether the tag starts a new paragraph.
void	processingInstruction(String target, String data)	Receive notification of an XML processing instruction anywhere in the document.
InputSource	resolveEntity(String publicId, String systemId)	Resolves an external entity.
void	startCDATA()	Report the start of a CDATA section.
void	startDocument()	Receive notification of the beginning of the document.
void	startDTD(String name, String publicId, String systemId)	Report the start of DTD declarations, if any.
void	startElement(String uri, String localName, String qName, Attributes attributes)	Receive notification of the start of an element.
void	startEntity(String name)	Not used: Report the beginning of some internal and external XML entities.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, notationDecl, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Constructor Details

Handler

public Handler(Translator translator,
 XMLDialect dialect,
 File inFile,
 @Nullable File outFile,
 FilterContext fc)
        throws IOException

Creates a new instance of Handler

Throws:

IOException

Method Details

getProcessedFiles

public @Nullable List<File> getProcessedFiles()

Returns external files this handler has processed, because they were included into main file. Each entry is File.

getContext

public FilterContext getContext()

doResolve

public InputSource doResolve(String publicId,
 String systemId)
                      throws SAXException

Resolves an external entity and provides an InputSource for the entity. The method handles resolving based on the public ID and system ID provided, and checks for specific URI schemas to determine the type of resolution required. Additionally, it performs translation and writing if necessary and resolves external entities from the project's source folder.

Parameters:

publicId - The public identifier of the entity being resolved.

systemId - The system identifier of the entity being resolved.

Returns:

An InputSource object representing the resolved entity. If the entity cannot be resolved, it returns an empty InputSource.

Throws:

SAXException - If there is an error during XML parsing.

isParagraphTag

public boolean isParagraphTag(Tag tag)

Returns whether the tag starts a new paragraph.

resolveEntity

public InputSource resolveEntity(String publicId,
 String systemId)
                          throws SAXException

Resolves an external entity.

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

Throws:

SAXException

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attributes)
                  throws SAXException

Receive notification of the start of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String qName)
                throws SAXException

Receive notification of the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Receive notification of character data inside an element.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
 int start,
 int length)

Receive notification of ignorable whitespace in element content.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

comment

public void comment(char[] ch,
 int start,
 int length)
             throws SAXException

Receive notification of an XML comment anywhere in the document.

Specified by:

comment in interface LexicalHandler

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
 String data)

Receive notification of an XML processing instruction anywhere in the document.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

startDocument

public void startDocument()
                   throws SAXException

Receive notification of the beginning of the document.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Receive notification of the end of the document.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

Report a fatal XML parsing error. Is used to provide feedback.

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException

startDTD

public void startDTD(String name,
 String publicId,
 String systemId)

Report the start of DTD declarations, if any.

Specified by:

startDTD in interface LexicalHandler

endDTD

public void endDTD()

Report the end of DTD declarations. Queues the DTD declaration with all the entities declared.

Specified by:

endDTD in interface LexicalHandler

startCDATA

public void startCDATA()

Report the start of a CDATA section.

Specified by:

startCDATA in interface LexicalHandler

endCDATA

public void endCDATA()

Report the end of a CDATA section.

Specified by:

endCDATA in interface LexicalHandler

startEntity

public void startEntity(String name)

Not used: Report the beginning of some internal and external XML entities.

Specified by:

startEntity in interface LexicalHandler

endEntity

public void endEntity(String name)
               throws SAXException

Report the end of an entity.

Specified by:

endEntity in interface LexicalHandler

Parameters:

name - The name of the entity that is ending.

Throws:

SAXException - The application may raise an exception.

See Also:

• startEntity(java.lang.String)

internalEntityDecl

public void internalEntityDecl(String name,
 String value)
                        throws SAXException

Report an internal entity declaration.

Specified by:

internalEntityDecl in interface DeclHandler

Throws:

SAXException

externalEntityDecl

public void externalEntityDecl(String name,
 String publicId,
 String systemId)
                        throws SAXException

Report a parsed external entity declaration.

Specified by:

externalEntityDecl in interface DeclHandler

Throws:

SAXException

elementDecl

public void elementDecl(String name,
 String model)

Not used: An element type declaration.

Specified by:

elementDecl in interface DeclHandler

attributeDecl

public void attributeDecl(String eName,
 String aName,
 String type,
 String valueDefault,
 String value)

Not used: An attribute type declaration.

Specified by:

attributeDecl in interface DeclHandler