IProcessor (Okapi Framework SDK 1.42.0 API)

All Known Implementing Classes:

ITSEngine
```
public interface IProcessor
```
Provides the mathods to apply ITS rules and markup to a given document.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DC_ALL` Flag for all categories (forward compatible).
`static long`	`DC_ALLOWEDCHARS` Flag for the Allowed Characters data category (ITS 2.0)
`static long`	`DC_DIRECTIONALITY` Flag for the Directionality data category (ITS 1.0)
`static long`	`DC_DOMAIN` Flag for the Domain data category (ITS 2.0)
`static long`	`DC_EXTERNALRES` Flag for the External Resource data category (ITS 2.0)
`static long`	`DC_IDVALUE` Flag for the Id Value data category (ITS 2.0)
`static long`	`DC_LANGINFO` Flag for the Language Information data category (ITS 1.0)
`static long`	`DC_LOCFILTER` Flag for the Locale Filter data category (ITS 2.0)
`static long`	`DC_LOCNOTE` Flag for the Localization Note data category (ITS 1.0, enhanced in 2.0)
`static long`	`DC_LOCQUALITYISSUE` Flag for the Localization Quality Issue data category (ITS 2.0)
`static long`	`DC_LOCQUALITYRATING` Flag for the Localization Quality Rating data category (ITS 2.0)
`static long`	`DC_MTCONFIDENCE` Flag for the MT Confidence data category (ITS 2.0)
`static long`	`DC_PRESERVESPACE` Flag for the Preserve Space data category (ITS 2.0)
`static long`	`DC_PROVENANCE` Flag for the Provenance data category (ITS 2.0)
`static long`	`DC_STORAGESIZE` Flag for the Storage Size data category (ITS 2.0)
`static long`	`DC_SUBFILTER` Flag for the Sub-Filter definition data category (Extension)
`static long`	`DC_TARGETPOINTER` Flag for the Target Pointer data category (ITS 2.0)
`static long`	`DC_TERMINOLOGY` Flag for the Terminology data category (ITS 1.0, enhanced in 2.0)
`static long`	`DC_TEXTANALYSIS` Flag for the Text Analysis data category (ITS 2.0)
`static long`	`DC_TRANSLATE` Flag for the Translate data category (ITS 1.0)
`static long`	`DC_WITHINTEXT` Flag for the Elements Within Text data category (ITS 1.0)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addExternalRules(Document rulesDoc, URI docURI)` Adds a set of global rules to the document to process.
`void`	`addExternalRules(URI docURI)` Adds a set of global rules to the document to process.
`void`	`applyRules(long dataCategories)` Applies the current ITS rules to the document.
`void`	`disapplyRules()` Removes all the special flags added when applying the ITS rules.

- Field Detail
  - DC_TRANSLATE
```
static final long DC_TRANSLATE
```
    Flag for the Translate data category (ITS 1.0)
    
    See Also:
    
    Constant Field Values
  - DC_LOCNOTE
```
static final long DC_LOCNOTE
```
    Flag for the Localization Note data category (ITS 1.0, enhanced in 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_TERMINOLOGY
```
static final long DC_TERMINOLOGY
```
    Flag for the Terminology data category (ITS 1.0, enhanced in 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_DIRECTIONALITY
```
static final long DC_DIRECTIONALITY
```
    Flag for the Directionality data category (ITS 1.0)
    
    See Also:
    
    Constant Field Values
  - DC_LANGINFO
```
static final long DC_LANGINFO
```
    Flag for the Language Information data category (ITS 1.0)
    
    See Also:
    
    Constant Field Values
  - DC_WITHINTEXT
```
static final long DC_WITHINTEXT
```
    Flag for the Elements Within Text data category (ITS 1.0)
    
    See Also:
    
    Constant Field Values
  - DC_DOMAIN
```
static final long DC_DOMAIN
```
    Flag for the Domain data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_TEXTANALYSIS
```
static final long DC_TEXTANALYSIS
```
    Flag for the Text Analysis data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_LOCFILTER
```
static final long DC_LOCFILTER
```
    Flag for the Locale Filter data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_PROVENANCE
```
static final long DC_PROVENANCE
```
    Flag for the Provenance data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_EXTERNALRES
```
static final long DC_EXTERNALRES
```
    Flag for the External Resource data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_TARGETPOINTER
```
static final long DC_TARGETPOINTER
```
    Flag for the Target Pointer data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_IDVALUE
```
static final long DC_IDVALUE
```
    Flag for the Id Value data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_PRESERVESPACE
```
static final long DC_PRESERVESPACE
```
    Flag for the Preserve Space data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_LOCQUALITYISSUE
```
static final long DC_LOCQUALITYISSUE
```
    Flag for the Localization Quality Issue data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_LOCQUALITYRATING
```
static final long DC_LOCQUALITYRATING
```
    Flag for the Localization Quality Rating data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_MTCONFIDENCE
```
static final long DC_MTCONFIDENCE
```
    Flag for the MT Confidence data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_ALLOWEDCHARS
```
static final long DC_ALLOWEDCHARS
```
    Flag for the Allowed Characters data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_STORAGESIZE
```
static final long DC_STORAGESIZE
```
    Flag for the Storage Size data category (ITS 2.0)
    
    See Also:
    
    Constant Field Values
  - DC_SUBFILTER
```
static final long DC_SUBFILTER
```
    Flag for the Sub-Filter definition data category (Extension)
    
    See Also:
    
    Constant Field Values
  - DC_ALL
```
static final long DC_ALL
```
    Flag for all categories (forward compatible).
    
    See Also:
    
    Constant Field Values
- 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.

Interface IProcessor

Field Summary

Method Summary

Field Detail

DC_TRANSLATE

DC_LOCNOTE

DC_TERMINOLOGY

DC_DIRECTIONALITY

DC_LANGINFO

DC_WITHINTEXT

DC_DOMAIN

DC_TEXTANALYSIS

DC_LOCFILTER

DC_PROVENANCE

DC_EXTERNALRES

DC_TARGETPOINTER

DC_IDVALUE

DC_PRESERVESPACE

DC_LOCQUALITYISSUE

DC_LOCQUALITYRATING

DC_MTCONFIDENCE

DC_ALLOWEDCHARS

DC_STORAGESIZE

DC_SUBFILTER

DC_ALL

Method Detail

addExternalRules

addExternalRules

applyRules

disapplyRules