Package net.sf.okapi.common.resource

Interfaces and classes that represent the parsed resources attached to the events sent by a filter.

See: Description

Interface Summary

Interface	Description
IAlignedSegments	Provides the methods to access all the source and target Segments of a ITextUnit.
IMultilingual
INameable	Provides the methods common to all resources that can be named.
IReferenceable	Interface for all resources that can be passed as referents through the filter events.
ISegments	Provides the methods to access all the segments of a TextContainer.
ITextUnit	Interface for the basic unit of extraction from a filter and also the resource associated with the filter event TEXT_UNIT.
IWithAnnotations
IWithProperties
IWithSkeleton
IWithSourceProperties
IWithTargetProperties

Class Summary

Class	Description
AlignedPair	An aligned pair consists of a source and target list of TextParts or Segments, along with a LocaleId specifying the locale of the target.
AlignedSegments	Provides a standard implementation of the IAlignedSegments interface that works with variant sources.
AnnotatedSpan	Span of text and its annotation data.
BaseNameable	Implements a nameable resource.
BaseReferenceable	Implements a nameable resource that can be a referent.
Code	Represents an abstracted in-line code used in a TextFragment object.
CodeComparatorOnData
CodeComparatorOnId
CodeComparatorOnIsolated
CodeComparatorOnTagType
CodeComparatorOnType
CodeMatches
CodeSimplifier
CodeTypeBuilder	Provides a code type builder.
Custom
DocumentPart	Resource associated with the filter events DOCUMENT_PART,
Ending	Resource associated with the filter events END_DOCUMENT, END_SUBDOCUMENT, and END_GROUP.
EndSubfilter	Ending IResource for StartSubfilter
InlineAnnotation	Base implementation of an annotation that can be used on inline codes.
MultiEvent	Special resource that holds one or more events.
PipelineParameters	Special resource used to carry runtime parameters.
Property	Represents a read-only or a modifiable property associated with a resource.
RawDocument	Resource that carries all the information needed for a filter to open a given document, and also the resource associated with the event RAW_DOCUMENT.
Segment	Implement a special content part that is a segment.
Segments
StartDocument	Resource associated with the filter event START_DOCUMENT.
StartGroup	Resource associated with the filter event START_GROUP.
StartSubDocument	Resource associated with the filter event START_SUBDOCUMENT.
StartSubfilter
TargetPropertiesAnnotation	The target properties associated to a set of source properties in a resource.
TextContainer	Provides methods for storing the content of a paragraph-type unit, to handle its properties, annotations and segmentation.
TextFragment	Implements the methods for creating and manipulating a pre-parsed flat representation of a content with in-line codes.
TextFragmentUtil
TextPart	Implements the base object for the parts that make up a content.
TextPartComparator
TextUnit	Basic unit of extraction from a filter and also the resource associated with the filter event TEXT_UNIT.
TextUnitUtil	Helper methods to manipulate TextFragment, TextContainer, and TextUnit objects.

Enum Summary

Enum	Description
AlignmentStatus	Segment alignmment status.
ExtendedCodeType	Provides extended code types.
TextFragment.CompareMode	Enum constants to specify how compareTo should work.
TextFragment.Marker	List of the marker types as an Enum.
TextFragment.TagType	List of the types of tag usable for in-line codes.
WhitespaceStrategy

Exception Summary

Exception	Description
InvalidContentException	Indicates that an action was trying to inline code or codes incompatible between themselves.
InvalidPositionException	Indicates that an action was using the second specil character of an inline code marker as a normal character.

Package net.sf.okapi.common.resource Description

Interfaces and classes that represent the parsed resources attached to the events sent by a filter.

This package provides the core interfaces and classes that are used to create, store and manipulate the different types of resources generated during the processing of a document by a filter.