Package net.sf.okapi.filters.vtt

Class VTTFilter

java.lang.Object

net.sf.okapi.common.filters.AbstractFilter

net.sf.okapi.filters.subtitles.SubtitleFilter

net.sf.okapi.filters.vtt.VTTFilter

All Implemented Interfaces:

AutoCloseable, Iterator<Event>, IFilter

public class VTTFilter
extends SubtitleFilter

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILTER_MIME
static String	FILTER_NAME
static Pattern	HEADER_PATTERN
static String	HEADER_REGEX

Fields inherited from class net.sf.okapi.filters.subtitles.SubtitleFilter

DEFAULT_TIME_FORMAT, eventBuilder, formatter, hasUtf8Bom, hasUtf8Encoding, maxChar, maxLine, params, terminalPattern

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

SUB_FILTER

Constructor Summary

Constructors

Constructor	Description
VTTFilter()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the input document.
ISkeletonWriter	createSkeletonWriter()	Default case.
VTTParameters	getParameters()	Gets the current parameters for this filter.
protected String	getTerminalRegex()
Event	next()	Gets the next event available.
void	open(RawDocument input, boolean generateSkeleton)	Opens the input document described in a give RawDocument object, and optionally creates skeleton information.
void	setParameters(IParameters params)	Sets new parameters for this filter.

Methods inherited from class net.sf.okapi.filters.subtitles.SubtitleFilter

addCaptionAnnotation, addString, addToDocumentPart, addToTextUnit, endFilter, endsWithPunctuation, getDateTimeFormatter, getMaxChar, getMaxLine, hasNext, isCJK, isInsideTextRun, isUtf8Bom, isUtf8Encoding, makeCaptionAnnotation, needToAppendWhitespace, needToPrependWhitespace, open

Methods inherited from class net.sf.okapi.common.filters.AbstractFilter

addConfiguration, addConfiguration, addConfiguration, addConfigurations, cancel, createEndFilterEvent, createFilterWriter, createStartFilterEvent, findConfiguration, getConfiguration, getConfigurations, getDisplayName, getDocumentId, getDocumentName, getEncoderManager, getEncoding, getFilterConfigurationMapper, getMimeType, getName, getNewlineType, getParameters, getParametersClassName, getParentId, getSrcLoc, getTrgLoc, isCanceled, isGenerateSkeleton, isMultilingual, removeConfiguration, setDisplayName, setDocumentName, setEncoding, setFilterConfigurationMapper, setGenerateSkeleton, setMimeType, setMultilingual, setName, setNewlineType, setOptions, setParentId, setSrcLoc, setTrgLoc

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

stream

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Detail

FILTER_NAME

public static final String FILTER_NAME

See Also:

Constant Field Values

FILTER_MIME

public static final String FILTER_MIME

See Also:

Constant Field Values

HEADER_REGEX

public static final String HEADER_REGEX

See Also:

Constant Field Values

HEADER_PATTERN

public static final Pattern HEADER_PATTERN

Constructor Detail

VTTFilter

public VTTFilter()

Method Detail

setParameters

public void setParameters(IParameters params)

Description copied from interface: IFilter

Sets new parameters for this filter.

Specified by:

setParameters in interface IFilter

Overrides:

setParameters in class SubtitleFilter

Parameters:

params - The new parameters to use.

getParameters

public VTTParameters getParameters()

Description copied from interface: IFilter

Gets the current parameters for this filter.

Specified by:

getParameters in interface IFilter

Overrides:

getParameters in class SubtitleFilter

Returns:

The current parameters for this filter, or DefaultParameters if this filter has no parameters.

createSkeletonWriter

public ISkeletonWriter createSkeletonWriter()

Description copied from class: AbstractFilter

Default case. Override if needed.

Specified by:

createSkeletonWriter in interface IFilter

Overrides:

createSkeletonWriter in class AbstractFilter

Returns:

new instance of GenericSkeletonWriter

close

public void close()

Description copied from interface: IFilter

Closes the input document. Developers should call this method from within their code before sending the last event: This can allow writer objects to overwrite the input file when they receive the last event. This method must also be safe to call even if the input document is not opened.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IFilter

Overrides:

close in class AbstractFilter

open

public void open(RawDocument input,
                 boolean generateSkeleton)

Description copied from interface: IFilter

Opens the input document described in a give RawDocument object, and optionally creates skeleton information.

Specified by:

open in interface IFilter

Overrides:

open in class SubtitleFilter

Parameters:

input - The RawDocument object to use to open the document.

generateSkeleton - true to generate the skeleton data, false otherwise.

next

public Event next()

Description copied from interface: IFilter

Gets the next event available. Calling this method can be done only once on each event.

Returns:

The next event available or null if there are no events.

getTerminalRegex

protected String getTerminalRegex()

Specified by:

getTerminalRegex in class SubtitleFilter