TextContainer (Okapi Framework SDK 1.41.0 API)

java.lang.Object
- net.sf.okapi.common.resource.TextContainer

All Implemented Interfaces:

Cloneable, Iterable<TextPart>, IResource, INameable, IWithAnnotations, IWithBilingualProperties, IWithProperties
```
public class TextContainer
extends Object
implements INameable, Iterable<TextPart>
```
Provides methods for storing the content of a paragraph-type unit, to handle its properties, annotations and segmentation.
The TextContainer is made of a collection of parts: Some are simple TextPart objects, others are special TextPart objects called Segment.
A TextContainer has always at least one Segment part.

Field Summary
- Fields inherited from interface net.sf.okapi.common.IResource
  COPY_ALL, COPY_CONTENT, COPY_PROPERTIES, COPY_SEGMENTATION, COPY_SEGMENTED_CONTENT, CREATE_EMPTY

Constructor Summary

Constructors
Constructor and Description
`TextContainer()` Creates a new empty TextContainer object.
`TextContainer(Segment segment)` Creates a new TextContainer object with an initial segment.
`TextContainer(String text)` Creates a new TextContainer object with some initial text.
`TextContainer(TextFragment fragment)` Creates a new TextContainer object with an initial TextFragment.
`TextContainer(TextPart... parts)` Creates a new TextContainer object with initial `TextPart`s (segment or non-segment) appended.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(String text)` Appends a part with a given text at the end of this container.
`void`	`append(String text, boolean collapseIfPreviousEmpty)` Appends a part with a given text at the end of this container.
`void`	`append(TextFragment fragment)` Appends a part at the end of this container.
`void`	`append(TextFragment fragment, boolean collapseIfPreviousEmpty)` Appends a part at the end of this container.
`void`	`append(TextFragment fragment, boolean collapseIfPreviousEmpty, boolean keepCodeIds)` Appends a part at the end of this container.
`void`	`append(TextPart part)` Appends a `TextPart` (segment or non-segment) at the end of this container.
`void`	`append(TextPart part, boolean collapseIfPreviousEmpty)` Appends a `TextPart` (segment or non-segment) at the end of this container.
`void`	`changePart(int partIndex)` Changes the type of a given part.
`void`	`clear()` Clears this TextContainer, removes any existing segments.
`TextContainer`	`clone()` Clones this TextContainer, including the properties.
`TextContainer`	`clone(boolean cloneProperties)` Clones this container, with or without its properties.
`int`	`compareTo(TextContainer cont, boolean codeSensitive)` Compares this container with another one.
`boolean`	`contentIsOneSegment()` Indicates if this container is made of a single segment that holds the whole content (i.e.
`static String[]`	`contentToSplitStorage(TextContainer tc)` Create two storage strings to serialize a given `TextContainer`.
`static String`	`contentToString(TextContainer tc)` Creates a string that stores the content of a given container.
`int`	`count()` Gets the number of parts (segments and non-segments) in this container.
`TextFragment`	`createJoinedContent()`
`Property`	`createTargetProperty(LocaleId locId, String name, boolean overwriteExisting, int creationOptions)` This method is intentionally not supported with TextContainer.
`TextPart`	`get(int index)` Gets the part (segment or non-segment) for a given part index.
`<A extends IAnnotation> A`	`getAnnotation(Class<A> type)` Gets the annotation object for a given class for this resource.
`Annotations`	`getAnnotations()` Gets the iterable list of the annotations for this resource.
`String`	`getCodedText()` Gets the coded text of the whole content (segmented or not).
`TextFragment`	`getFirstContent()` Gets the content of the first part (segment or non-segment) of this container.
`Segment`	`getFirstSegment()` Returns the first `Segment` of this container.
`String`	`getId()` This method is intentionally not supported with TextContainer.
`TextFragment`	`getLastContent()` Gets the content of the last part (segment or non-segment) of this container.
`String`	`getMimeType()` This method always returns null.
`String`	`getName()` This method always returns null.
`List<TextPart>`	`getParts()`
`protected LinkedHashMap<String,Property>`	`getProperties()`
`Property`	`getProperty(String name)` Gets the resource-level property for a given name.
`Set<String>`	`getPropertyNames()` Gets the names of all the resource-level properties for this resource.
`ISegments`	`getSegments()` Creates a new `ISegments` object to access the segments of this container.
`ISkeleton`	`getSkeleton()` This method is intentionally not supported with TextContainer.
`Property`	`getSourceProperty(String name)` This method is intentionally not supported with TextContainer.
`Set<String>`	`getSourcePropertyNames()` This method is intentionally not supported with TextContainer.
`Set<LocaleId>`	`getTargetLocales()` This method is intentionally not supported with TextContainer.
`Property`	`getTargetProperty(LocaleId locId, String name)` This method is intentionally not supported with TextContainer.
`Set<String>`	`getTargetPropertyNames(LocaleId locId)` This method is intentionally not supported with TextContainer.
`String`	`getType()` This method is intentionally not supported with TextContainer.
`TextFragment`	`getUnSegmentedContentCopy()` Gets a new TextFragment representing the un-segmented content of this container.
`boolean`	`hasBeenSegmented()` Indicates if a segmentation has been applied to this container.
`boolean`	`hasProperty(String name)` Indicates if a resource-level property exists for a given name.
`boolean`	`hasSourceProperty(String name)` This method is intentionally not supported with TextContainer.
`boolean`	`hasTargetProperty(LocaleId locId, String name)` This method is intentionally not supported with TextContainer.
`boolean`	`hasText()` Indicates if this fragment contains at least one character that is 'text' (inline codes, segment markers, and annotation markers do not count as 'text' characters).
`boolean`	`hasText(boolean whiteSpacesAreText)` Indicates if this container contains at least one character that is not a whitespace.
`boolean`	`hasText(boolean lookInSegments, boolean whiteSpacesAreText)` Indicates if this container contains at least one character.
`void`	`insert(int partIndex, TextPart part)` Inserts a given part (segment or non-segment) at a given position.
`boolean`	`isEmpty()` Indicates if this container is empty (no text and no codes).
`boolean`	`isTranslatable()` This method is intentionally not supported with TextContainer.
`Iterator<TextPart>`	`iterator()` Creates an iterator to loop through the parts (segments and non-segments) of this container.
`void`	`joinAll()` Merges back together all parts (segments and non-segments) of this container, and clear the list of segments.
`int`	`joinWithNext(int partIndex, int partCount)` Joins a given part with a specified number of its following parts.
`boolean`	`preserveWhitespaces()` This method is intentionally not supported with TextContainer.
`void`	`remove(int partIndex)` Removes the part at s given position.
`void`	`removeProperty(String name)` Removes a resource-level property of a given name.
`void`	`removeSourceProperty(String name)` This method is intentionally not supported with TextContainer.
`void`	`removeTargetProperty(LocaleId locId, String name)` This method is intentionally not supported with TextContainer.
`void`	`setAnnotation(IAnnotation annotation)` Sets an annotation object for this resource.
`protected void`	`setAnnotations(Annotations annotations)`
`void`	`setContent(TextFragment content)` Sets the content of this TextContainer.
`TextContainer`	`setContentFromString(String data)` Sets content of this TextContainer from a string created by `contentToString(TextContainer)`.
`void`	`setHasBeenSegmentedFlag(boolean hasBeenSegmented)` Sets the flag indicating if the content of this container has been segmented.
`void`	`setId(String id)` This method is intentionally not supported with TextContainer.
`void`	`setIsTranslatable(boolean value)` This method is intentionally not supported with TextContainer.
`void`	`setMimeType(String value)` This method is intentionally not supported with TextContainer.
`void`	`setName(String name)` This method is intentionally not supported with TextContainer.
`void`	`setParts(TextPart... parts)`
`void`	`setPreserveWhitespaces(boolean value)` This method is intentionally not supported with TextContainer.
`protected void`	`setProperties(LinkedHashMap<String,Property> properties)`
`Property`	`setProperty(Property property)` Sets a resource-level property.
`protected void`	`setSegments(Segments segments)`
`void`	`setSkeleton(ISkeleton skeleton)` This method is intentionally not supported with TextContainer.
`Property`	`setSourceProperty(Property property)` This method is intentionally not supported with TextContainer.
`Property`	`setTargetProperty(LocaleId locId, Property property)` This method is intentionally not supported with TextContainer.
`void`	`setType(String value)` This method is intentionally not supported with TextContainer.
`void`	`split(int partIndex, int start, int end, boolean spannedPartIsSegment)` Splits a given part into two or three parts.
`static TextContainer`	`splitStorageToContent(String ctext, String codes)` Creates a new `TextContainer` object from two strings generated with `contentToSplitStorage(TextContainer)`.
`static TextContainer`	`stringToContent(String data)` Converts a string created by `contentToString(TextContainer)` back into a TextContainer.
`String`	`toString()` Gets the string representation of this container.
`void`	`unwrap(boolean trimEnds, boolean collapseMode)` Unwraps the content of this container.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.okapi.common.resource.IWithProperties
copy

Methods inherited from interface net.sf.okapi.common.resource.IWithBilingualProperties
copy

Methods inherited from interface net.sf.okapi.common.resource.IWithAnnotations
copy

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - TextContainer
```
public TextContainer()
```
    Creates a new empty TextContainer object.
  - TextContainer
```
public TextContainer(String text)
```
    Creates a new TextContainer object with some initial text.
    
    Parameters:
    
    text - the initial text.
  - TextContainer
```
public TextContainer(TextFragment fragment)
```
    Creates a new TextContainer object with an initial TextFragment.
    
    Parameters:
    
    fragment - the initial TextFragment.
  - TextContainer
```
public TextContainer(TextPart... parts)
```
    Creates a new TextContainer object with initial TextParts (segment or non-segment) appended.
    
    Parameters:
    
    parts - the given initial parts.
  - TextContainer
```
public TextContainer(Segment segment)
```
    Creates a new TextContainer object with an initial segment. If the id of the segment is null it will be set automatically.
    
    Parameters:
    
    segment - the initial segment.
- Method Detail
  - getSegments
```
public ISegments getSegments()
```
    Creates a new ISegments object to access the segments of this container.
    
    Returns:
    
    a new ISegments object.
  - contentToString
```
public static String contentToString(TextContainer tc)
```
    Creates a string that stores the content of a given container. Use stringToContent(String) to create the container back from the string.
    IMPORTANT: Only the content is saved (not the properties, annotations, etc.).
    
    Parameters:
    
    tc - the container holding the content to store.
    
    Returns:
    
    a string representing the content of the given container.
  - stringToContent
```
public static TextContainer stringToContent(String data)
```
    Converts a string created by contentToString(TextContainer) back into a TextContainer.
    
    Parameters:
    
    data - the string to process.
    
    Returns:
    
    a new TextConatiner with the stored content re-created.
  - setContentFromString
```
public TextContainer setContentFromString(String data)
```
    Sets content of this TextContainer from a string created by contentToString(TextContainer).
    
    Parameters:
    
    data - the string to process.
    
    Returns:
    
    this TextConatiner.
  - contentToSplitStorage
```
public static String[] contentToSplitStorage(TextContainer tc)
```
    Create two storage strings to serialize a given TextContainer. Use splitStorageToContent(String, String) to create the container back from the strings.
    IMPORTANT: Only the content is saved (not the properties, annotations, etc.).
    
    Parameters:
    
    tc - the text container to store.
    
    Returns:
    
    An array of two String objects: The first one contains the coded text parts, the second one contains the codes.
    
    See Also:
    
    splitStorageToContent(String, String)
  - splitStorageToContent
```
public static TextContainer splitStorageToContent(String ctext,
                                                  String codes)
```
    Creates a new TextContainer object from two strings generated with contentToSplitStorage(TextContainer).
    
    Parameters:
    
    ctext - the string holding the coded text parts.
    
    codes - the string holding the codes.
    
    Returns:
    
    a new TextContainer object created from the strings.
    
    See Also:
    
    contentToSplitStorage(TextContainer)
  - toString
```
public String toString()
```
    Gets the string representation of this container. If the container is segmented, the representation shows the merged segments. Inline codes are also included.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of this container.
  - iterator
```
public Iterator<TextPart> iterator()
```
    Creates an iterator to loop through the parts (segments and non-segments) of this container.
    
    Specified by:
    
    iterator in interface Iterable<TextPart>
    
    Returns:
    
    a new iterator all for the parts of this container.
  - compareTo
```
public int compareTo(TextContainer cont,
                     boolean codeSensitive)
```
    Compares this container with another one. Note: This is a costly operation if the two containers have segments and no text differences.
    
    Parameters:
    
    cont - the other container to compare this one with.
    
    codeSensitive - true if the codes need to be compared as well.
    
    Returns:
    
    a value 0 if the objects are equals.
  - hasBeenSegmented
```
public boolean hasBeenSegmented()
```
    Indicates if a segmentation has been applied to this container. Note that it does not mean there is more than one segment or one part. Use contentIsOneSegment() to check if the container counts only one segment (whether is is the result of a segmentation or simply the default single segment).
    This method return true if any method that may cause the content to be segmented has been called, and no operation has resulted in un-segmenting the content since that call, or if the content has more than one part.
    
    Returns:
    
    true if a segmentation has been applied to this container.
    
    See Also:
    
    setHasBeenSegmentedFlag(boolean)
  - setHasBeenSegmentedFlag
```
public void setHasBeenSegmentedFlag(boolean hasBeenSegmented)
```
    Sets the flag indicating if the content of this container has been segmented.
    
    Parameters:
    
    hasBeenSegmented - true to flag the content has having been segmented, false to set it has not having been segmented.
    
    See Also:
    
    hasBeenSegmented()
  - contentIsOneSegment
```
public boolean contentIsOneSegment()
```
    Indicates if this container is made of a single segment that holds the whole content (i.e. there is no other parts).
    When this method returns true, the methods getFirstContent(), ISegments.getFirstContent(), getLastContent() and ISegments.getLastContent() return the same result.
    
    Returns:
    
    true if the whole content of this container is in a single segment.
    
    See Also:
    
    count(), ISegments.count()
  - changePart
```
public void changePart(int partIndex)
```
    Changes the type of a given part. If the part was a segment this makes it a non-segment (except if this is the only part in the content. In that case the part remains unchanged). If this part was not a segment this makes it a segment (with its identifier automatically set).
    
    Parameters:
    
    partIndex - the index of the part to change. Note that even if the part is a segment this index must be the part index not the segment index.
  - insert
```
public void insert(int partIndex,
                   TextPart part)
```
    Inserts a given part (segment or non-segment) at a given position. If the position is already occupied that part and all the parts to it right are shifted to the right.
    If the part to insert is a segment, its id is validated.
    
    Parameters:
    
    partIndex - the position where to insert the new part.
    
    part - the part to insert.
  - remove
```
public void remove(int partIndex)
```
    Removes the part at s given position.
    If the selected part is the last segment in the content, the part is only cleared, not removed.
    
    Parameters:
    
    partIndex - the position of the part to remove.
  - append
```
public void append(TextFragment fragment,
                   boolean collapseIfPreviousEmpty)
```
    Appends a part at the end of this container.
    If collapseIfPreviousEmpty and if the current last part (segment or non-segment) is empty, the text fragment is appended to the last part. Otherwise the text fragment is appended to the content as a new non-segment part.
    Important: If the container is empty, the appended part becomes a segment, as the container has always at least one segment.
    
    Parameters:
    
    fragment - the text fragment to append.
    
    collapseIfPreviousEmpty - true to collapse the previous part if it is empty.
  - append
```
public void append(TextFragment fragment,
                   boolean collapseIfPreviousEmpty,
                   boolean keepCodeIds)
```
    Appends a part at the end of this container.
    If collapseIfPreviousEmpty and if the current last part (segment or non-segment) is empty, the text fragment is appended to the last part. Otherwise the text fragment is appended to the content as a new non-segment part.
    Important: If the container is empty, the appended part becomes a segment, as the container has always at least one segment.
    
    Parameters:
    
    fragment - the text fragment to append.
    
    collapseIfPreviousEmpty - true to collapse the previous part if it is empty.
    
    keepCodeIds - true to block code balancing.
  - append
```
public void append(TextFragment fragment)
```
    Appends a part at the end of this container.
    This call is the same as calling append(TextFragment, boolean) with collapseIfPreviousEmpty set to true.
    
    Parameters:
    
    fragment - the text fragment to append.
  - append
```
public void append(String text,
                   boolean collapseIfPreviousEmpty)
```
    Appends a part with a given text at the end of this container.
    If collapseIfPreviousEmpty is true and if the current last part (segment or non-segment) is empty, the new text is appended to the last part part. Otherwise the text is appended to the content as a new non-segment part.
    
    Parameters:
    
    text - the text to append.
    
    collapseIfPreviousEmpty - true to collapse the previous part if it is empty.
  - append
```
public void append(String text)
```
    Appends a part with a given text at the end of this container.
    This call is the same as calling append(String, boolean) with collapseIfPreviousEmpty set to true.
    
    Parameters:
    
    text - the text to append.
  - append
```
public void append(TextPart part,
                   boolean collapseIfPreviousEmpty)
```
    Appends a TextPart (segment or non-segment) at the end of this container.
    If collapseiIfPreviousEmpty is true and if the current last part (segment or non-segment) is empty, the new part replaces the last part. Otherwise the part is appended to the container as it. If the result of the operation would result in a container without segment, the first part is automatically converted to a fragment.
    
    Parameters:
    
    part - the TextPart to append.
    
    collapseIfPreviousEmpty - true to collapse the previous part if it is empty.
  - append
```
public void append(TextPart part)
```
    Appends a TextPart (segment or non-segment) at the end of this container.
    This call is the same as calling append(TextPart, boolean) with collapseIfPreviousEmpty set to true.
    
    Parameters:
    
    part - the TextPart to append.
  - getCodedText
```
public String getCodedText()
```
    Gets the coded text of the whole content (segmented or not). Use this method to compute segment boundaries that will be applied using ISegments.create(int, int) or ISegments.create(List) or other methods.
    
    Returns:
    
    the coded text of the whole content to use for segmentation template.
    
    See Also:
    
    ISegments.create(int, int), ISegments.create(List)
  - split
```
public void split(int partIndex,
                  int start,
                  int end,
                  boolean spannedPartIsSegment)
```
    Splits a given part into two or three parts.
    - If end == start or end or -1 : A new part is created on the right side of the position. It has the same type as the original part.
    - If start == 0: A new part is created on the left side of the original part.
    - If the specified span is empty at either end of the part, or if it is equals to the whole length of the part: No change (it would result in an empty part). It has the type specified by spannedPartIsSegment.
    Parameters:
    
    partIndex - index of the part to split.
    
    start - start of the middle part to create.
    
    end - position just after the last character of the middle part to create.
    
    spannedPartIsSegment - true if the new middle part should be a segment, false if it should be a non-segment.
  - unwrap
```
public void unwrap(boolean trimEnds,
                   boolean collapseMode)
```
    Unwraps the content of this container.
    This method replaces any sequences of white-spaces by a single space character. It also removes leading and trailing white-spaces if the parameter trimEnds is set to true.
    White spaces in this context are #x9, #xA and #x20. #xD is not considered a whitespace as the content of a text container must have its line-breaks normalized to #xA.
    If the container has more than one segment and if collapseMode mode is set: non-segments parts are normalized and removed if they end up empty. If the option is not set: the method preserve at least one space between segments, even if the segments are empty.
    Empty segments are always left.
    Currently there is no provision to not unwrap a given span of the content.
    
    Parameters:
    
    trimEnds - true to remove leading and trailing white-spaces.
    
    collapseMode - true to remove non-segments parts that end up empty after the unwrapping.
  - getFirstContent
```
public TextFragment getFirstContent()
```
    Gets the content of the first part (segment or non-segment) of this container.
    This method always returns the same result as ISegments.getFirstContent() if contentIsOneSegment() is true.
    
    Returns:
    
    the content of the first part (segment or non-segment) of this container.
    
    See Also:
    
    ISegments.getFirstContent(), getLastContent(), ISegments.getLastContent()
  - getFirstSegment
```
public Segment getFirstSegment()
```
    Returns the first Segment of this container.
    
    Returns:
    
    the first Segment of this container or null if there is no Segment
  - getLastContent
```
public TextFragment getLastContent()
```
    Gets the content of the last part (segment or non-segment) of this container.
    This method always returns the same result as ISegments.getLastContent() if contentIsOneSegment().
    
    Returns:
    
    the content of the last part (segment or non-segment) of this container.
    
    See Also:
    
    ISegments.getLastContent(), getFirstContent(), ISegments.getFirstContent()
  - clone
```
public TextContainer clone()
```
    Clones this TextContainer, including the properties.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A new TextContainer object that is a copy of this one.
  - clone
```
public TextContainer clone(boolean cloneProperties)
```
    Clones this container, with or without its properties.
    
    Parameters:
    
    cloneProperties - indicates if the properties should be cloned.
    
    Returns:
    
    A new TextContainer object that is a copy of this one.
  - getUnSegmentedContentCopy
```
public TextFragment getUnSegmentedContentCopy()
```
    Gets a new TextFragment representing the un-segmented content of this container.
    Important: This is an expensive method.
    
    Returns:
    
    an un-segmented copy of the content of this container.
  - setContent
```
public void setContent(TextFragment content)
```
    Sets the content of this TextContainer. Any existing segmentation is removed. The content becomes a single segment content.
    
    Parameters:
    
    content - the new content to set.
  - setParts
```
public void setParts(TextPart... parts)
```
  - clear
```
public void clear()
```
    Clears this TextContainer, removes any existing segments. The content becomes a single empty segment content. Keeps annotations.
  - hasText
```
public boolean hasText(boolean lookInSegments,
                       boolean whiteSpacesAreText)
```
    Indicates if this container contains at least one character. Inline codes and annotation markers do not count as characters.
    - If the whole content is a single segment the check is performed on that content and the option lookInSegments is ignored.
    - If the content has several segments or if the single segment is not the whole content, each segment is checked only if lookInSegment is set.
    - The holder is always checked if no text is found in the segments.
    Parameters:
    
    lookInSegments - indicates if the possible segments in this containers should be looked at. If this parameter is set to false, the segment marker are treated as codes.
    
    whiteSpacesAreText - indicates if whitespaces should be considered text characters or not.
    
    Returns:
    
    true if this container contains at least one character according the given options.
  - hasText
```
public boolean hasText(boolean whiteSpacesAreText)
```
    Indicates if this container contains at least one character that is not a whitespace. All parts (segments and non-segments) are checked.
    
    Parameters:
    
    whiteSpacesAreText - indicates if whitespaces should be considered text characters or not.
    
    Returns:
    
    true if this container contains at least one character that is not a whitespace.
  - hasText
```
public boolean hasText()
```
    Indicates if this fragment contains at least one character that is 'text' (inline codes, segment markers, and annotation markers do not count as 'text' characters). This method has the same result as calling hasText(boolean, boolean) with the parameters true and false.
    
    Returns:
    
    true if this container contains at least one character that is not a whitespace.
  - isEmpty
```
public boolean isEmpty()
```
    Indicates if this container is empty (no text and no codes).
    
    Returns:
    
    true if this container is empty.
  - hasProperty
```
public boolean hasProperty(String name)
```
    Description copied from interface: IWithProperties
    
    Indicates if a resource-level property exists for a given name.
    
    Specified by:
    
    hasProperty in interface IWithProperties
    
    Parameters:
    
    name - The name of the resource-level property to query.
    
    Returns:
    
    True if a resource-level property exists, false otherwise.
  - getProperty
```
public Property getProperty(String name)
```
    Description copied from interface: IWithProperties
    
    Gets the resource-level property for a given name.
    
    Specified by:
    
    getProperty in interface IWithProperties
    
    Parameters:
    
    name - Name of the property to retrieve.
    
    Returns:
    
    The property or null if it does not exist.
  - setProperty
```
public Property setProperty(Property property)
```
    Description copied from interface: IWithProperties
    
    Sets a resource-level property. If a property already exists it is overwritten.
    
    Specified by:
    
    setProperty in interface IWithProperties
    
    Parameters:
    
    property - The new property to set.
    
    Returns:
    
    The property that has been set.
  - removeProperty
```
public void removeProperty(String name)
```
    Description copied from interface: IWithProperties
    
    Removes a resource-level property of a given name. If the property does not exists nothing happens.
    
    Specified by:
    
    removeProperty in interface IWithProperties
    
    Parameters:
    
    name - The name of the property to remove.
  - getPropertyNames
```
public Set<String> getPropertyNames()
```
    Description copied from interface: IWithProperties
    
    Gets the names of all the resource-level properties for this resource.
    
    Specified by:
    
    getPropertyNames in interface IWithProperties
    
    Returns:
    
    All the names of the resource-level properties for this resource.
  - getAnnotations
```
public Annotations getAnnotations()
```
    Description copied from interface: IWithAnnotations
    
    Gets the iterable list of the annotations for this resource.
    
    Specified by:
    
    getAnnotations in interface IWithAnnotations
    
    Returns:
    
    the iterable list of the annotations for this resource.
  - getAnnotation
```
public <A extends IAnnotation> A getAnnotation(Class<A> type)
```
    Description copied from interface: IWithAnnotations
    
    Gets the annotation object for a given class for this resource.
    
    Specified by:
    
    getAnnotation in interface IWithAnnotations
    
    Type Parameters:
    
    A - the type of the class.
    
    Parameters:
    
    type - the class of the annotation object to retrieve.
    
    Returns:
    
    the annotation for the given class for this resource.
  - setAnnotation
```
public void setAnnotation(IAnnotation annotation)
```
    Description copied from interface: IWithAnnotations
    
    Sets an annotation object for this resource.
    
    Specified by:
    
    setAnnotation in interface IWithAnnotations
    
    Parameters:
    
    annotation - the annotation object to set.
  - get
```
public TextPart get(int index)
```
    Gets the part (segment or non-segment) for a given part index.
    
    Parameters:
    
    index - the index of the part to retrieve. the first part has the index 0, the second has the index 1, etc.
    
    Returns:
    
    the part (segment or non-segment) for the given index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
    
    See Also:
    
    ISegments.get(int)
  - count
```
public int count()
```
    Gets the number of parts (segments and non-segments) in this container. This method always returns at least 1.
    
    Returns:
    
    the number of parts (segments and non-segments) in this container.
    
    See Also:
    
    ISegments.count()
  - createJoinedContent
```
public TextFragment createJoinedContent()
```
  - joinAll
```
public void joinAll()
```
    Merges back together all parts (segments and non-segments) of this container, and clear the list of segments. The content becomes a single segment content. WARNING: All TextPart annotations and Properties are lost after joining
  - joinWithNext
```
public int joinWithNext(int partIndex,
                        int partCount)
```
    Joins a given part with a specified number of its following parts.
    If the resulting part is the only part in the container and is not a segment, it is set automatically changed into a segment.
    joinWithNext(0, -1) has the same effect as joinAll();
    
    Parameters:
    
    partIndex - the index of the part where to append the following parts.
    
    partCount - the number of parts to join. You can use -1 to indicate all the parts after the initial one.
    
    Returns:
    
    the number of parts joined to the given part (and removed from the list of parts).
  - getParts
```
public List<TextPart> getParts()
```
  - getProperties
```
protected LinkedHashMap<String,Property> getProperties()
```
  - setProperties
```
protected void setProperties(LinkedHashMap<String,Property> properties)
```
  - setSegments
```
protected void setSegments(Segments segments)
```
  - setAnnotations
```
protected void setAnnotations(Annotations annotations)
```
  - getId
```
public String getId()
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    getId in interface IResource
    
    Returns:
    
    the identifier of this resource.
  - setId
```
public void setId(String id)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    setId in interface IResource
    
    Parameters:
    
    id - the new identifier value.
    
    See Also:
    
    IResource.getId()
  - getSkeleton
```
public ISkeleton getSkeleton()
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    getSkeleton in interface IResource
    
    Returns:
    
    the skeleton object for this resource or null if there is none.
  - setSkeleton
```
public void setSkeleton(ISkeleton skeleton)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    setSkeleton in interface IResource
    
    Parameters:
    
    skeleton - the skeleton object to set.
  - getName
```
public String getName()
```
    This method always returns null. It is intentionally not supported with TextContainer.
    
    Specified by:
    
    getName in interface INameable
    
    Returns:
    
    This resource name, or null if there is none.
  - setName
```
public void setName(String name)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    setName in interface INameable
    
    Parameters:
    
    name - New name to set.
  - getType
```
public String getType()
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    getType in interface INameable
    
    Returns:
    
    The type information associated with this resource.
  - setType
```
public void setType(String value)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    setType in interface INameable
    
    Parameters:
    
    value - The new type information.
  - getMimeType
```
public String getMimeType()
```
    This method always returns null. It is intentionally not supported with TextContainer.
    
    Specified by:
    
    getMimeType in interface INameable
    
    Returns:
    
    The type of content of this resource.
  - setMimeType
```
public void setMimeType(String value)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    setMimeType in interface INameable
    
    Parameters:
    
    value - The new type of content of this resource.
  - getSourceProperty
```
public Property getSourceProperty(String name)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    getSourceProperty in interface IWithBilingualProperties
    
    Parameters:
    
    name - The name of the source property to retrieve.
    
    Returns:
    
    The property or null if it does not exist.
  - setSourceProperty
```
public Property setSourceProperty(Property property)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    setSourceProperty in interface IWithBilingualProperties
    
    Parameters:
    
    property - The new property to set.
    
    Returns:
    
    The property that has been set.
  - removeSourceProperty
```
public void removeSourceProperty(String name)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    removeSourceProperty in interface IWithBilingualProperties
    
    Parameters:
    
    name - The name of the property to remove.
  - getSourcePropertyNames
```
public Set<String> getSourcePropertyNames()
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    getSourcePropertyNames in interface IWithBilingualProperties
    
    Returns:
    
    All the names of the source properties for this resource.
  - hasSourceProperty
```
public boolean hasSourceProperty(String name)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    hasSourceProperty in interface IWithBilingualProperties
    
    Parameters:
    
    name - The name of the source property to query.
    
    Returns:
    
    True if a source property exists, false otherwise.
  - getTargetProperty
```
public Property getTargetProperty(LocaleId locId,
                                  String name)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    getTargetProperty in interface IWithBilingualProperties
    
    Parameters:
    
    locId - the locale of the property to retrieve.
    
    name - The name of the property to retrieve. This name is case-sensitive.
    
    Returns:
    
    The property or null if it does not exist.
  - setTargetProperty
```
public Property setTargetProperty(LocaleId locId,
                                  Property property)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    setTargetProperty in interface IWithBilingualProperties
    
    Parameters:
    
    locId - The target locale for which this property should be set.
    
    property - The new property to set. This name is case-sensitive.
    
    Returns:
    
    The property that has been set.
  - removeTargetProperty
```
public void removeTargetProperty(LocaleId locId,
                                 String name)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    removeTargetProperty in interface IWithBilingualProperties
    
    Parameters:
    
    locId - The target locale for which this property should be set.
    
    name - The name of the property to remove.
  - getTargetPropertyNames
```
public Set<String> getTargetPropertyNames(LocaleId locId)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    getTargetPropertyNames in interface IWithBilingualProperties
    
    Parameters:
    
    locId - the target locale to query.
    
    Returns:
    
    all the names of the target properties for the given locale in this resource.
  - getTargetLocales
```
public Set<LocaleId> getTargetLocales()
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    getTargetLocales in interface IWithBilingualProperties
    
    Returns:
    
    all the target locales for this resource.
  - hasTargetProperty
```
public boolean hasTargetProperty(LocaleId locId,
                                 String name)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    hasTargetProperty in interface IWithBilingualProperties
    
    Parameters:
    
    locId - the target locale to query.
    
    name - the name of the property to query.
    
    Returns:
    
    true if a property exists, false otherwise.
  - createTargetProperty
```
public Property createTargetProperty(LocaleId locId,
                                     String name,
                                     boolean overwriteExisting,
                                     int creationOptions)
```
    This method is intentionally not supported with TextContainer.
    Specified by:
    
    createTargetProperty in interface INameable
    
    Parameters:
    
    locId - The target locale to use.
    
    name - The name of the property to create (or retrieve)
    
    overwriteExisting - True to overwrite any existing property. False to not create a new property if one exists already.
    creationOptions - Creation options:
    CREATE_EMPTY: Creates an empty property, only the read-only flag of the source is copied.
    
    COPY_CONTENT: Creates a new property with all its data copied from the source.
    Returns:
    
    The property that was created, or retrieved.
  - isTranslatable
```
public boolean isTranslatable()
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    isTranslatable in interface INameable
    
    Returns:
    
    True if the content of this resource is translatable. False if it is not translatable.
  - setIsTranslatable
```
public void setIsTranslatable(boolean value)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    setIsTranslatable in interface INameable
    
    Parameters:
    
    value - True to indicate that the content of this resource is translatable.
  - preserveWhitespaces
```
public boolean preserveWhitespaces()
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    preserveWhitespaces in interface INameable
    
    Returns:
    
    True if the white-spaces in the content of this resource should be preserved.
  - setPreserveWhitespaces
```
public void setPreserveWhitespaces(boolean value)
```
    This method is intentionally not supported with TextContainer.
    
    Specified by:
    
    setPreserveWhitespaces in interface INameable
    
    Parameters:
    
    value - True to indicate that the white-spaces in the content of this resource should be preserved.

Class TextContainer

Field Summary

Fields inherited from interface net.sf.okapi.common.IResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.okapi.common.resource.IWithProperties

Methods inherited from interface net.sf.okapi.common.resource.IWithBilingualProperties

Methods inherited from interface net.sf.okapi.common.resource.IWithAnnotations

Methods inherited from interface java.lang.Iterable

Constructor Detail

TextContainer

TextContainer

TextContainer

TextContainer

TextContainer

Method Detail

getSegments

contentToString

stringToContent

setContentFromString

contentToSplitStorage

splitStorageToContent

toString

iterator

compareTo

hasBeenSegmented

setHasBeenSegmentedFlag

contentIsOneSegment

changePart

insert

remove

append

append

append

append

append

append

append

getCodedText

split

unwrap

getFirstContent

getFirstSegment

getLastContent

clone

clone

getUnSegmentedContentCopy

setContent

setParts

clear

hasText

hasText

hasText

isEmpty

hasProperty

getProperty

setProperty

removeProperty

getPropertyNames

getAnnotations

getAnnotation

setAnnotation

get

count

createJoinedContent

joinAll

joinWithNext

getParts

getProperties

setProperties

setSegments

setAnnotations

getId

setId

getSkeleton

setSkeleton

getName

setName

getType