Package net.sf.okapi.filters.its.html5

Class HTML5Filter

java.lang.Object

net.sf.okapi.filters.its.ITSFilter

net.sf.okapi.filters.its.html5.HTML5Filter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

public class HTML5Filter
extends ITSFilter

HTML5-ITS Filter supporting both embedded and external ITS xpath rules.

Field Summary

Fields inherited from class net.sf.okapi.filters.its.ITSFilter

doc, docName, encoderManager, encoding, fcMapper, hasUTF8BOM, input, lineBreak, params, skel, srcLang

Fields inherited from interface net.sf.okapi.common.filters.IFilter

SUB_FILTER

Constructor Summary

Constructors

Constructor	Description
HTML5Filter()

Method Summary

Modifier and Type	Method	Description
protected void	applyRules(ITSEngine itsEng)
ISkeletonWriter	createSkeletonWriter()	Creates a new ISkeletonWriter object that corresponds to the type of skeleton this filter uses.
protected void	createStartDocumentSkeleton(StartDocument startDoc)
List<FilterConfiguration>	getConfigurations()	Gets the list of all predefined configurations for this filter.
String	getDisplayName()	Gets the localizable display name of this filter.
EncoderManager	getEncoderManager()	Gets the EncoderManager object for this filter.
String	getName()	Gets the name/identifier of this filter.
protected void	initializeDocument()
static void	loadLinkedRules(Document doc, URI docURI, ITSEngine itsEng)	Loads the linked rules of an HTML document.

Methods inherited from class net.sf.okapi.filters.its.ITSFilter

cancel, close, createFilterWriter, getMimeType, getParameters, getTargetPointerEntry, hasNext, next, open, open, setFilterConfigurationMapper, setITSVariables, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.okapi.common.filters.IFilter

isMultilingual, stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

HTML5Filter

public HTML5Filter()

Method Detail

getName

public String getName()

Description copied from interface: IFilter

Gets the name/identifier of this filter.

Returns:

The name/identifier of the filter.

getDisplayName

public String getDisplayName()

Description copied from interface: IFilter

Gets the localizable display name of this filter.

Returns:

the localizable display name of this filter.

getConfigurations

public List<FilterConfiguration> getConfigurations()

Description copied from interface: IFilter

Gets the list of all predefined configurations for this filter.

Returns:

a list of the all predefined configurations for this filter.

createSkeletonWriter

public ISkeletonWriter createSkeletonWriter()

Description copied from interface: IFilter

Creates a new ISkeletonWriter object that corresponds to the type of skeleton this filter uses.

Specified by:

createSkeletonWriter in interface IFilter

Specified by:

createSkeletonWriter in class ITSFilter

Returns:

A new instance of ISkeletonWriter for the type of skeleton this filter uses.

getEncoderManager

public EncoderManager getEncoderManager()

Description copied from interface: IFilter

Gets the EncoderManager object for this filter. This encoder manager should provided the mappings to the different MIME types used by the filter.

Returns:

the EncoderManager for this filter.

initializeDocument

protected void initializeDocument()

Specified by:

initializeDocument in class ITSFilter

applyRules

protected void applyRules(ITSEngine itsEng)

Overrides:

applyRules in class ITSFilter

createStartDocumentSkeleton

protected void createStartDocumentSkeleton(StartDocument startDoc)

Specified by:

createStartDocumentSkeleton in class ITSFilter

loadLinkedRules

public static void loadLinkedRules(Document doc,
                                   URI docURI,
                                   ITSEngine itsEng)

Loads the linked rules of an HTML document.

Parameters:

doc - the document to process.

docURI - the document URI.

itsEng - the engine to use.