Package org.w3c.its

Interface IProcessor

  • All Known Implementing Classes:
    ITSEngine
    public interface IProcessor
    Provides the mathods to apply ITS rules and markup to a given document.

    • Method Detail

      • addExternalRules

        void addExternalRules​(Document rulesDoc,
                      URI docURI)
        Adds a set of global rules to the document to process.

        The rules are added to the internal storage of the document, not to the document tree.

        Use this method to add one rule set or more before calling applyRules(long).

        Parameters:
        rulesDoc - Document where the global rules are declared.
        docURI - URI of the document. This is needed because xlink:href need a initial location.

      • addExternalRules

        void addExternalRules​(URI docURI)
        Adds a set of global rules to the document to process. See addExternalRules(Document, URI) for more details.
        Parameters:
        docURI - URI of the document that contains the rules to add.

      • applyRules

        void applyRules​(long dataCategories)
        Applies the current ITS rules to the document. This method decorates the document tree with special flags that are used for getting the different ITS information later.
        Parameters:
        dataCategories - Flag indicating what data categories to apply. The value must be one of the DC_* values or several combined with a OR operator. For example: applyRules(DC_TRANSLATE | DC_LOCNOTE);

        Use DC_ALL to apply all data categories.

      • disapplyRules

        void disapplyRules()
        Removes all the special flags added when applying the ITS rules. Once you have called this method you should call applyRules(long) again to be able to use ITS-aware methods again.