Package net.sf.okapi.common.resource

Class AlignedSegments

  • All Implemented Interfaces:
    Iterable<Segment>, IAlignedSegments
    public class AlignedSegments
extends Object
implements IAlignedSegments
    Provides a standard implementation of the IAlignedSegments interface that works with variant sources.

    Currently tightly coupled to ITextUnit.

    • Constructor Detail

      • AlignedSegments

        public AlignedSegments​(ITextUnit parent)

    • Method Detail

      • append

        public void append​(Segment srcSeg,
                   Segment trgSeg,
                   LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Adds given source and target segments to the end of the content.

        If srcSeg is non-null, the content of srcSeg will be used for any new segments that are not empty, otherwise the content of trgSeg will be used. srcSeg and trgSeg cannot both be null.

        Specified by:
        append in interface IAlignedSegments
        Parameters:
        srcSeg - the source segment to add.
        trgSeg - the target segment to add. Null to use a clone of srcSeg instead.
        trgLoc - the target locale for which to append segments

      • insert

        public void insert​(int index,
                   Segment srcSeg,
                   Segment trgSeg,
                   LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Inserts given source and target segments at the specified position in the list of segments.

        The validated id (after insertion) of srcSeg will be applied to all other inserted segments, including trgSeg.

        Specified by:
        insert in interface IAlignedSegments
        Parameters:
        index - the segment index position.
        srcSeg - the source segment to insert.
        trgSeg - the target segment to insert. Null to use srcSeg instead.
        trgLoc - the target locale for which to insert the segment

      • setSegment

        public void setSegment​(int index,
                       Segment seg,
                       LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Replaces a segment at a given position with a clone of the given segment.

        The segment id is determined by the segment at the position of index in the source for trgLoc, the segment id is then used to locate the segments in other sources and targets to replace.

        Specified by:
        setSegment in interface IAlignedSegments
        Parameters:
        index - the segment index position
        seg - the new segment to place at the position
        trgLoc - the target locale

      • remove

        public boolean remove​(Segment seg,
                      LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Removes the given segment and any segments with the same id from the specified sources and targets.
        Specified by:
        remove in interface IAlignedSegments
        Parameters:
        seg - the segment to remove.
        trgLoc - the locale used in specifying which sources and targets to use.
        Returns:
        true if remove success

      • getSource

        public Segment getSource​(int index,
                         LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Gets the source segment for the given target locale at a given position.

        The first segment has the index 0, the second has the index 1, etc.

        Specified by:
        getSource in interface IAlignedSegments
        Parameters:
        index - the segment index of the segment to retrieve.
        trgLoc - the target locale for the source from which to retrieve the indicated segment.
        Returns:
        the segment at the given position.

      • getCorrespondingTarget

        public Segment getCorrespondingTarget​(Segment srcSeg,
                                      LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Gets the target segment corresponding to a given source segment
        Specified by:
        getCorrespondingTarget in interface IAlignedSegments
        Parameters:
        srcSeg - the source (or other target) segment for which a corresponding target segment is requested.
        trgLoc - the target to look up.
        Returns:
        the corresponding target Segment (may be empty).

      • getCorrespondingSource

        public Segment getCorrespondingSource​(Segment trgSeg,
                                      LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Gets the source segment corresponding to a given target segment
        Specified by:
        getCorrespondingSource in interface IAlignedSegments
        Parameters:
        trgSeg - the target segment for which the corresponding source segment is requested.
        trgLoc - the target locale of the source to look up.
        Returns:
        the source segment.

      • align

        public void align​(List<AlignedPair> alignedSegmentPairs,
                  LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Aligns all the segments listed in the aligned pairs for given locale.

        This will replace any content in the target and variant source for the given target locale (if either are not present they will be created).

        The target for the given locale will be considered aligned with its source when this operation is complete.

        Specified by:
        align in interface IAlignedSegments
        Parameters:
        alignedSegmentPairs - the list of pairs to align
        trgLoc - the target locale to work with.

      • align

        public void align​(LocaleId trgLoc)
        Force one to one alignment. Assume that both source and target have the same number of segments.
        Specified by:
        align in interface IAlignedSegments
        Parameters:
        trgLoc - target locale used to align with the source

      • alignCollapseAll

        public void alignCollapseAll​(LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Aligns all the segments for the specified sources and targets by collapsing all segments into one.
        Specified by:
        alignCollapseAll in interface IAlignedSegments
        Parameters:
        trgLoc - the target locale of the target (and its corresponding source) to collapse.

      • splitSource

        public Segment splitSource​(LocaleId trgLoc,
                           Segment srcSeg,
                           int splitPos)
        Description copied from interface: IAlignedSegments
        Splits a given source segment into two.

        Alignment statuses are updated for the locales that have been modified. May cause a misalignment.

        Specified by:
        splitSource in interface IAlignedSegments
        Parameters:
        trgLoc - the target locale that uses the source in which the segment is to be split
        srcSeg - the source segment to split.
        splitPos - the position where to split.
        Returns:
        the new source segment created, or null if none was created.

      • splitTarget

        public Segment splitTarget​(LocaleId trgLoc,
                           Segment trgSeg,
                           int splitPos)
        Description copied from interface: IAlignedSegments
        Splits a given target segment into two.

        Alignment statuses are updated for the locales that have been modified. May cause a misalignment.

        Specified by:
        splitTarget in interface IAlignedSegments
        Parameters:
        trgLoc - the target locale to work on.
        trgSeg - the targets segment.
        splitPos - the position where to split.
        Returns:
        the new target segment created, or null if none was created.

      • joinWithNext

        public void joinWithNext​(Segment seg,
                         LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Joins the segment for a given segment's id to the next segment, including all the parts between the two segments.
        Specified by:
        joinWithNext in interface IAlignedSegments
        Parameters:
        seg - a segment holding the id to use for the join.
        trgLoc - the target locale

      • joinAll

        public void joinAll​(LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Joins all segments for the specified sources and targets. The content becomes a single segment.
        Specified by:
        joinAll in interface IAlignedSegments
        Parameters:
        trgLoc - the target locale

      • getAlignmentStatus

        public AlignmentStatus getAlignmentStatus()
        Description copied from interface: IAlignedSegments
        Gets the status of the alignment for this entire text unit. The status will be NOT_ALIGNED if any of the targets in the parent TextUnit have a status of NOT_ALIGNED
        Specified by:
        getAlignmentStatus in interface IAlignedSegments
        Returns:
        the status of the alignment for this text unit.

      • getAlignmentStatus

        public AlignmentStatus getAlignmentStatus​(LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Gets the status of the alignment the given target locale in this text unit.
        Specified by:
        getAlignmentStatus in interface IAlignedSegments
        Parameters:
        trgLoc - the target locale for which to get the alignment status.
        Returns:
        the status of the alignment for this text unit.

      • segmentSource

        public void segmentSource​(ISegmenter segmenter,
                          LocaleId targetLocale)
        Description copied from interface: IAlignedSegments
        Segments the source content used for the given target locale based on the rules provided by a given ISegmenter.

        No associated targets are modified.

        Specified by:
        segmentSource in interface IAlignedSegments
        Parameters:
        segmenter - the segmenter to use to create the segments.
        targetLocale - the target locale that uses the source to segment.

      • segmentTarget

        public void segmentTarget​(ISegmenter segmenter,
                          LocaleId targetLocale)
        Description copied from interface: IAlignedSegments
        Segments the specified target content based on the rules provided by a given ISegmenter.

        If the given target does not exist one is created.

        Specified by:
        segmentTarget in interface IAlignedSegments
        Parameters:
        segmenter - the segmenter to use to create the segments.
        targetLocale - LocaleId of the target we want to segment.

      • iterator

        public Iterator<Segment> iterator()
        Description copied from interface: IAlignedSegments
        Gets an iterator for the default source segments of this text unit. This iterator does not iterate through non-segment parts of the content.
        Specified by:
        iterator in interface IAlignedSegments
        Specified by:
        iterator in interface Iterable<Segment>
        Returns:
        an iterator for the source segments of this text unit.

      • iterator

        public Iterator<Segment> iterator​(LocaleId trgLoc)
        Description copied from interface: IAlignedSegments
        Gets an iterator for the source of the specified target locale. This iterator does not iterate through non-segment parts of the content.
        Specified by:
        iterator in interface IAlignedSegments
        Parameters:
        trgLoc - the target locale for the source to iterate over.
        Returns:
        an iterator for the source segments used for trgLoc.

      • getParent

        public final ITextUnit getParent()