TextPieceTable (POI API Documentation)

java.lang.Object
- org.apache.poi.hwpf.model.TextPieceTable

All Implemented Interfaces:

CharIndexTranslator

Direct Known Subclasses:

OldTextPieceTable
```
@Internal
public class TextPieceTable
extends java.lang.Object
implements CharIndexTranslator
```
The piece table for matching up character positions to bits of text. This mostly works in bytes, but the TextPieces themselves work in characters. This does the icky convertion. (用于将字符位置与文本位匹配的片段表。这主要以字节为单位，但 TextPieces 本身以字符为单位。这会进行 icky 转换。)

Author:

Ryan Ackley

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`TextPieceTable.FCComparator`

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.ArrayList<TextPiece>`	`_textPieces`
`protected java.util.ArrayList<TextPiece>`	`_textPiecesFCOrder`

Constructor Summary

Constructors
Constructor and Description
`TextPieceTable()`
`TextPieceTable(byte[] documentStream, byte[] tableStream, int offset, int size, int fcMin)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(TextPiece piece)`
`int`	`adjustForInsert(int listIndex, int length)` Adjust all the text piece after inserting some text into one of them (将一些文本插入其中之一后调整所有文本片段)
`boolean`	`equals(java.lang.Object o)`
`int`	`getByteIndex(int charPos)` Calculates the byte index of the given char index. (计算给定字符索引的字节索引。)
`int`	`getCharIndex(int bytePos)` Deprecated. (已弃用。)
`int`	`getCharIndex(int startBytePos, int startCP)` Deprecated. (已弃用。)
`int[][]`	`getCharIndexRanges(int startBytePosInclusive, int endBytePosExclusive)` Finds character ranges that includes specified byte range. (查找包含指定字节范围的字符范围。)
`int`	`getCpMin()`
`protected int`	`getEncodingMultiplier(TextPiece textPiece)`
`java.lang.StringBuilder`	`getText()`
`java.util.List<TextPiece>`	`getTextPieces()`
`int`	`hashCode()`
`boolean`	`isIndexInTable(int bytePos)` Check if index is in table (检查索引是否在表中)
`int`	`lookIndexBackward(int startBytePos)` Return last index <= bytePos that is in table (返回表中的最后一个索引 <= bytePos)
`int`	`lookIndexForward(int startBytePos)` Return first index >= bytePos that is in table (返回表中的第一个索引 >= bytePos)
`protected TextPiece`	`newTextPiece(int nodeStartChars, int nodeEndChars, byte[] buf, PieceDescriptor pd)`
`byte[]`	`writeTo(java.io.ByteArrayOutputStream docStream)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _textPieces
```
protected java.util.ArrayList<TextPiece> _textPieces
```
  - _textPiecesFCOrder
```
protected java.util.ArrayList<TextPiece> _textPiecesFCOrder
```
- Constructor Detail
  - TextPieceTable
```
public TextPieceTable()
```
  - TextPieceTable
```
public TextPieceTable(byte[] documentStream,
                      byte[] tableStream,
                      int offset,
                      int size,
                      int fcMin)
```
- Method Detail
  - newTextPiece
```
protected TextPiece newTextPiece(int nodeStartChars,
                                 int nodeEndChars,
                                 byte[] buf,
                                 PieceDescriptor pd)
```
  - add
```
public void add(TextPiece piece)
```
  - adjustForInsert
```
public int adjustForInsert(int listIndex,
                           int length)
```
    Adjust all the text piece after inserting some text into one of them (将一些文本插入其中之一后调整所有文本片段)
    
    Parameters:
    
    listIndex - The TextPiece that had characters inserted into (listIndex - 插入了字符的 TextPiece)
    
    length - The number of characters inserted (length - 插入的字符数)
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - getByteIndex
```
public int getByteIndex(int charPos)
```
    Description copied from interface: CharIndexTranslator
    
    Calculates the byte index of the given char index. (计算给定字符索引的字节索引。)
    
    Specified by:
    
    getByteIndex in interface CharIndexTranslator (接口 CharIndexTranslator 中的 getByteIndex)
    
    Parameters:
    
    charPos - The char position (charPos - 字符位置)
    
    Returns:
    
    The byte index (字节索引)
  - getCharIndex
```
@Deprecated
public int getCharIndex(int bytePos)
```
    Deprecated. (已弃用。)
  - getCharIndex
```
@Deprecated
public int getCharIndex(int startBytePos,
                                    int startCP)
```
    Deprecated. (已弃用。)
  - getCharIndexRanges
```
public int[][] getCharIndexRanges(int startBytePosInclusive,
                                  int endBytePosExclusive)
```
    Description copied from interface: CharIndexTranslator
    
    Finds character ranges that includes specified byte range. (查找包含指定字节范围的字符范围。)
    
    Specified by:
    
    getCharIndexRanges in interface CharIndexTranslator (接口 CharIndexTranslator 中的 getCharIndexRanges)
    
    Parameters:
    
    startBytePosInclusive - start byte range (startBytePosInclusive - 起始字节范围)
    
    endBytePosExclusive - end byte range (endBytePosExclusive - 结束字节范围)
  - getEncodingMultiplier
```
protected int getEncodingMultiplier(TextPiece textPiece)
```
  - getCpMin
```
public int getCpMin()
```
  - getText
```
public java.lang.StringBuilder getText()
```
  - getTextPieces
```
public java.util.List<TextPiece> getTextPieces()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - isIndexInTable
```
public boolean isIndexInTable(int bytePos)
```
    Description copied from interface: CharIndexTranslator
    
    Check if index is in table (检查索引是否在表中)
    
    Specified by:
    
    isIndexInTable in interface CharIndexTranslator (接口 CharIndexTranslator 中的 isIndexInTable)
    
    Returns:
    
    true if index in table, false if not (如果表中有索引，则为 true，否则为 false)
  - lookIndexBackward
```
public int lookIndexBackward(int startBytePos)
```
    Description copied from interface: CharIndexTranslator
    
    Return last index <= bytePos that is in table (返回表中的最后一个索引 <= bytePos)
    
    Specified by:
    
    lookIndexBackward in interface CharIndexTranslator (接口 CharIndexTranslator 中的lookIndexBackward)
    
    Returns:
    
    last index less of equal to bytePos that is in table (表中小于等于 bytePos 的最后一个索引)
  - lookIndexForward
```
public int lookIndexForward(int startBytePos)
```
    Description copied from interface: CharIndexTranslator
    
    Return first index >= bytePos that is in table (返回表中的第一个索引 >= bytePos)
    
    Specified by:
    
    lookIndexForward in interface CharIndexTranslator (接口 CharIndexTranslator 中的lookIndexForward)
    
    Returns:
    
    first index greater or equal to bytePos that is in table (表中大于或等于 bytePos 的第一个索引)
  - writeTo
```
public byte[] writeTo(java.io.ByteArrayOutputStream docStream)
               throws java.io.IOException
```
    Throws:
    
    java.io.IOException (java.io.IOException)

Class TextPieceTable

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_textPieces

_textPiecesFCOrder

Constructor Detail

TextPieceTable

TextPieceTable

Method Detail

newTextPiece

add

adjustForInsert

equals

getByteIndex

getCharIndex

getCharIndex

getCharIndexRanges

getEncodingMultiplier

getCpMin

getText

getTextPieces

hashCode

isIndexInTable

lookIndexBackward

lookIndexForward

writeTo