Package net.sf.okapi.filters.its

Class ITSFilter

    • Constructor Detail

      • ITSFilter

        public ITSFilter​(boolean isHTML5,
                 String mimeType,
                 long dataCategoriesToApply)

    • Method Detail

      • setITSVariables

        public void setITSVariables​(Map<String,​String> map)
        Sets the ITS variables to pass to the ITS parameters feature. This method should be called before open(RawDocument, boolean). Those variables overwrite the default values set in the its;params elements.
        Parameters:
        map - the map of variables to pass. Can be null or empty.

      • cancel

        public void cancel()
        Description copied from interface: IFilter
        Cancels the current process.
        Specified by:
        cancel in interface IFilter

      • 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

      • createSkeletonWriter

        public abstract 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
        Returns:
        A new instance of ISkeletonWriter for the type of skeleton this filter uses.

      • createFilterWriter

        public IFilterWriter createFilterWriter()
        Description copied from interface: IFilter
        Creates a new IFilterWriter object from the most appropriate class to use with this filter.
        Specified by:
        createFilterWriter in interface IFilter
        Returns:
        A new instance of IFilterWriter for the preferred implementation for this filter.

      • getMimeType

        public String getMimeType()
        Description copied from interface: IFilter
        Gets the MIME type of the format supported by this filter.
        Specified by:
        getMimeType in interface IFilter
        Returns:
        The MIME type of the format supported by this filter.

      • getParameters

        public Parameters getParameters()
        Description copied from interface: IFilter
        Gets the current parameters for this filter.
        Specified by:
        getParameters in interface IFilter
        Returns:
        The current parameters for this filter, or DefaultParameters if this filter has no parameters.

      • hasNext

        public boolean hasNext()
        Description copied from interface: IFilter
        Indicates if there is an event to process.

        Implementer Note: The caller must be able to call this method several times without changing state.

        Specified by:
        hasNext in interface IFilter
        Specified by:
        hasNext in interface Iterator<Event>
        Returns:
        True if there is at least one event to process, false if not.

      • 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.
        Specified by:
        next in interface IFilter
        Specified by:
        next in interface Iterator<Event>
        Returns:
        The next event available or null if there are no events.

      • open

        public void open​(RawDocument input)
        Description copied from interface: IFilter
        Opens the input document described in a give RawDocument object. Skeleton information is always created when you use this method.
        Specified by:
        open in interface IFilter
        Parameters:
        input - The RawDocument object to use to open the document.

      • setFilterConfigurationMapper

        public void setFilterConfigurationMapper​(IFilterConfigurationMapper fcMapper)
        Description copied from interface: IFilter
        Sets the filter configuration mapper for this filter. This object is used by this filter if it needs to instantiate sub-filters. The implementations of IFilter that do not use sub-filters can use an empty stub for this method.
        Specified by:
        setFilterConfigurationMapper in interface IFilter
        Parameters:
        fcMapper - the mapper to set.

      • setParameters

        public void setParameters​(IParameters params)
        Description copied from interface: IFilter
        Sets new parameters for this filter.
        Specified by:
        setParameters in interface IFilter
        Parameters:
        params - The new parameters to use.

      • initializeDocument

        protected abstract void initializeDocument()

      • applyRules

        protected void applyRules​(ITSEngine itsEng)

      • createStartDocumentSkeleton

        protected abstract void createStartDocumentSkeleton​(StartDocument startDoc)

      • 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
        Parameters:
        input - The RawDocument object to use to open the document.
        generateSkeleton - true to generate the skeleton data, false otherwise.

      • getTargetPointerEntry

        public net.sf.okapi.filters.its.TargetPointerEntry getTargetPointerEntry​(Node node)
        Gets the target pointer entry for a given node.
        Parameters:
        node - the node to examine.
        Returns:
        the target pointer entry for that node, or null if there is none.