Package org.apache.iotdb.tsfile.write.schema

Class MeasurementSchema

java.lang.Object

org.apache.iotdb.tsfile.write.schema.MeasurementSchema

All Implemented Interfaces:

Serializable, Comparable<MeasurementSchema>, IMeasurementSchema

public class MeasurementSchema
extends Object
implements IMeasurementSchema, Comparable<MeasurementSchema>, Serializable

This class describes a measurement's information registered in FileSchema, including measurement id, data type, encoding and compressor type. For each TSEncoding, MeasurementSchema maintains respective TSEncodingBuilder; For TSDataType, only ENUM has TSDataTypeConverter up to now.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MeasurementSchema()
MeasurementSchema(String measurementId, byte type, byte encoding, byte compressionType, Map<String,String> props)
MeasurementSchema(String measurementId, TSDataType tsDataType)
MeasurementSchema(String measurementId, TSDataType type, TSEncoding encoding)	set properties as an empty Map.
MeasurementSchema(String measurementId, TSDataType type, TSEncoding encoding, CompressionType compressionType)
MeasurementSchema(String measurementId, TSDataType type, TSEncoding encoding, CompressionType compressionType, Map<String,String> props)	Constructor of MeasurementSchema.

Method Summary

Modifier and Type	Method	Description
int	compareTo(MeasurementSchema o)	compare by measurementID.
boolean	containsSubMeasurement(String measurementId)
static MeasurementSchema	deserializeFrom(InputStream inputStream)	function for deserializing data from input stream.
static MeasurementSchema	deserializeFrom(ByteBuffer buffer)	function for deserializing data from byte buffer.
boolean	equals(Object o)
CompressionType	getCompressor()
TSEncoding	getEncodingType()
String	getMeasurementId()
Map<String,String>	getProps()
MeasurementSchemaType	getSchemaType()
int	getSubMeasurementIndex(String measurementId)
int	getSubMeasurementsCount()
List<Encoder>	getSubMeasurementsEncoderList()
List<String>	getSubMeasurementsList()
List<TSDataType>	getSubMeasurementsTSDataTypeList()
List<TSEncoding>	getSubMeasurementsTSEncodingList()
Encoder	getTimeEncoder()	function for getting time encoder.
TSEncoding	getTimeTSEncoding()
TSDataType	getType()
byte	getTypeInByte()
Encoder	getValueEncoder()	get Encoder of value from encodingConverter by measurementID and data type.
int	hashCode()
boolean	isLogicalView()
static MeasurementSchema	partialDeserializeFrom(ByteBuffer buffer)
int	partialSerializeTo(OutputStream outputStream)
int	partialSerializeTo(ByteBuffer buffer)
int	serializedSize()
int	serializeTo(OutputStream outputStream)	function for serializing data to output stream.
int	serializeTo(ByteBuffer buffer)	function for serializing data to byte buffer.
void	setCompressor(byte compressor)
void	setEncoding(byte encoding)
void	setMeasurementId(String measurementId)
void	setProps(Map<String,String> props)
void	setType(TSDataType type)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MeasurementSchema

public MeasurementSchema()

MeasurementSchema

public MeasurementSchema(String measurementId,
                         TSDataType tsDataType)

MeasurementSchema

public MeasurementSchema(String measurementId,
                         TSDataType type,
                         TSEncoding encoding)

set properties as an empty Map.

MeasurementSchema

public MeasurementSchema(String measurementId,
                         TSDataType type,
                         TSEncoding encoding,
                         CompressionType compressionType)

MeasurementSchema

public MeasurementSchema(String measurementId,
                         TSDataType type,
                         TSEncoding encoding,
                         CompressionType compressionType,
                         Map<String,String> props)

Constructor of MeasurementSchema.

props - information in encoding method. For RLE, Encoder.MAX_POINT_NUMBER For PLAIN, Encoder.maxStringLength

MeasurementSchema

public MeasurementSchema(String measurementId,
                         byte type,
                         byte encoding,
                         byte compressionType,
                         Map<String,String> props)

Method Detail

deserializeFrom

public static MeasurementSchema deserializeFrom(InputStream inputStream)
                                         throws IOException

function for deserializing data from input stream.

Throws:

IOException

deserializeFrom

public static MeasurementSchema deserializeFrom(ByteBuffer buffer)

function for deserializing data from byte buffer.

partialDeserializeFrom

public static MeasurementSchema partialDeserializeFrom(ByteBuffer buffer)

getSchemaType

public MeasurementSchemaType getSchemaType()

Specified by:

getSchemaType in interface IMeasurementSchema

getMeasurementId

public String getMeasurementId()

Specified by:

getMeasurementId in interface IMeasurementSchema

setMeasurementId

public void setMeasurementId(String measurementId)

getProps

public Map<String,String> getProps()

Specified by:

getProps in interface IMeasurementSchema

getEncodingType

public TSEncoding getEncodingType()

Specified by:

getEncodingType in interface IMeasurementSchema

getType

public TSDataType getType()

Specified by:

getType in interface IMeasurementSchema

getTypeInByte

public byte getTypeInByte()

Specified by:

getTypeInByte in interface IMeasurementSchema

getTimeTSEncoding

public TSEncoding getTimeTSEncoding()

Specified by:

getTimeTSEncoding in interface IMeasurementSchema

setProps

public void setProps(Map<String,String> props)

getTimeEncoder

public Encoder getTimeEncoder()

function for getting time encoder.

Specified by:

getTimeEncoder in interface IMeasurementSchema

getSubMeasurementsList

public List<String> getSubMeasurementsList()

Specified by:

getSubMeasurementsList in interface IMeasurementSchema

getSubMeasurementsTSDataTypeList

public List<TSDataType> getSubMeasurementsTSDataTypeList()

Specified by:

getSubMeasurementsTSDataTypeList in interface IMeasurementSchema

getSubMeasurementsTSEncodingList

public List<TSEncoding> getSubMeasurementsTSEncodingList()

Specified by:

getSubMeasurementsTSEncodingList in interface IMeasurementSchema

getSubMeasurementsEncoderList

public List<Encoder> getSubMeasurementsEncoderList()

Specified by:

getSubMeasurementsEncoderList in interface IMeasurementSchema

getValueEncoder

public Encoder getValueEncoder()

get Encoder of value from encodingConverter by measurementID and data type.

Specified by:

getValueEncoder in interface IMeasurementSchema

Returns:

Encoder for value

getCompressor

public CompressionType getCompressor()

Specified by:

getCompressor in interface IMeasurementSchema

serializeTo

public int serializeTo(OutputStream outputStream)
                throws IOException

function for serializing data to output stream.

Specified by:

serializeTo in interface IMeasurementSchema

Throws:

IOException

serializedSize

public int serializedSize()

Specified by:

serializedSize in interface IMeasurementSchema

serializeTo

public int serializeTo(ByteBuffer buffer)

function for serializing data to byte buffer.

Specified by:

serializeTo in interface IMeasurementSchema

partialSerializeTo

public int partialSerializeTo(OutputStream outputStream)
                       throws IOException

Specified by:

partialSerializeTo in interface IMeasurementSchema

Throws:

IOException

isLogicalView

public boolean isLogicalView()

Specified by:

isLogicalView in interface IMeasurementSchema

partialSerializeTo

public int partialSerializeTo(ByteBuffer buffer)

Specified by:

partialSerializeTo in interface IMeasurementSchema

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(MeasurementSchema o)

compare by measurementID.

Specified by:

compareTo in interface Comparable<MeasurementSchema>

toString

public String toString()

Overrides:

toString in class Object

setType

public void setType(TSDataType type)

Specified by:

setType in interface IMeasurementSchema

getSubMeasurementIndex

public int getSubMeasurementIndex(String measurementId)

Specified by:

getSubMeasurementIndex in interface IMeasurementSchema

getSubMeasurementsCount

public int getSubMeasurementsCount()

Specified by:

getSubMeasurementsCount in interface IMeasurementSchema

containsSubMeasurement

public boolean containsSubMeasurement(String measurementId)

Specified by:

containsSubMeasurement in interface IMeasurementSchema

setEncoding

public void setEncoding(byte encoding)

setCompressor

public void setCompressor(byte compressor)