TSEncodingBuilder (TsFile 1.2.1 API)

java.lang.Object
- org.apache.iotdb.tsfile.encoding.encoder.TSEncodingBuilder

Direct Known Subclasses:

TSEncodingBuilder.Chimp, TSEncodingBuilder.Dictionary, TSEncodingBuilder.GorillaV1, TSEncodingBuilder.GorillaV2, TSEncodingBuilder.Plain, TSEncodingBuilder.Regular, TSEncodingBuilder.RLBE, TSEncodingBuilder.Rle, TSEncodingBuilder.Sprintz, TSEncodingBuilder.Ts2Diff, TSEncodingBuilder.Zigzag
```
public abstract class TSEncodingBuilder
extends java.lang.Object
```
Each subclass of TSEncodingBuilder responds a enumerate value in TSEncoding, which stores several configuration related to responding encoding type to generate Encoder instance.
Each TSEncoding has a responding TSEncodingBuilder. The design referring to visit pattern provides same outer interface for different TSEncodings and gets rid of the duplicate switch-case code.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`TSEncodingBuilder.Chimp`	for FLOAT, DOUBLE, INT, LONG.
`static class`	`TSEncodingBuilder.Dictionary`
`static class`	`TSEncodingBuilder.GorillaV1`	for FLOAT, DOUBLE.
`static class`	`TSEncodingBuilder.GorillaV2`	for FLOAT, DOUBLE, INT, LONG.
`static class`	`TSEncodingBuilder.Plain`	for all TSDataType.
`static class`	`TSEncodingBuilder.Regular`	for INT32, INT64.
`static class`	`TSEncodingBuilder.RLBE`
`static class`	`TSEncodingBuilder.Rle`	for ENUMS, INT32, BOOLEAN, INT64, FLOAT, DOUBLE.
`static class`	`TSEncodingBuilder.Sprintz`
`static class`	`TSEncodingBuilder.Ts2Diff`	for INT32, INT64, FLOAT, DOUBLE.
`static class`	`TSEncodingBuilder.Zigzag`

Field Summary

Fields
Modifier and Type Field Description

protected TSFileConfig conf

Constructor Summary

Constructors
Modifier Constructor Description

protected TSEncodingBuilder()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract Encoder`	`getEncoder(TSDataType type)`	return a thread safe series's encoder with different types and parameters according to its measurement id and data type.
`static TSEncodingBuilder`	`getEncodingBuilder(TSEncoding type)`	return responding TSEncodingBuilder from a TSEncoding.
`abstract void`	`initFromProps(java.util.Map<java.lang.String,java.lang.String> props)`	for TSEncoding, JSON is a kind of type for initialization.
`java.lang.String`	`toString()`

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

- Field Detail
  - conf
```
protected final TSFileConfig conf
```
- Constructor Detail
  - TSEncodingBuilder
```
protected TSEncodingBuilder()
```
- Method Detail
  - getEncodingBuilder
```
public static TSEncodingBuilder getEncodingBuilder(TSEncoding type)
```
    return responding TSEncodingBuilder from a TSEncoding.
    
    Parameters:
    
    type - - given encoding type
    
    Returns:
    
    - responding TSEncodingBuilder
  - getEncoder
```
public abstract Encoder getEncoder(TSDataType type)
```
    return a thread safe series's encoder with different types and parameters according to its measurement id and data type.
    
    Parameters:
    
    type - - given data type
    
    Returns:
    
    - return a Encoder
  - initFromProps
```
public abstract void initFromProps(java.util.Map<java.lang.String,java.lang.String> props)
```
    for TSEncoding, JSON is a kind of type for initialization. InitFromJsonObject gets values from JSON object which will be used latter.
    if this type has extra parameters to construct, override it.
    
    Parameters:
    
    props - - properties of encoding
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object