Entity (DolphinDB Java API 1.30.21.3 API)

All Known Subinterfaces:

Chart, Dictionary, Matrix, Scalar, Set, Table, Vector

All Known Implementing Classes:

AbstractMatrix, AbstractScalar, AbstractVector, BasicAnyVector, BasicArrayVector, BasicBoolean, BasicBooleanMatrix, BasicBooleanVector, BasicByte, BasicByteMatrix, BasicByteVector, BasicChart, BasicChunkMeta, BasicComplex, BasicComplexMatrix, BasicComplexVector, BasicDate, BasicDateHour, BasicDateHourMatrix, BasicDateHourVector, BasicDateMatrix, BasicDateTime, BasicDateTimeMatrix, BasicDateTimeVector, BasicDateVector, BasicDecimal32, BasicDecimal32Vector, BasicDecimal64, BasicDecimal64Vector, BasicDictionary, BasicDouble, BasicDoubleMatrix, BasicDoubleVector, BasicDuration, BasicDurationVector, BasicFloat, BasicFloatMatrix, BasicFloatVector, BasicInt, BasicInt128, BasicInt128Vector, BasicIntMatrix, BasicIntVector, BasicIPAddr, BasicIPAddrVector, BasicLong, BasicLongMatrix, BasicLongVector, BasicMinute, BasicMinuteMatrix, BasicMinuteVector, BasicMonth, BasicMonthMatrix, BasicMonthVector, BasicNanoTime, BasicNanoTimeMatrix, BasicNanoTimestamp, BasicNanoTimestampMatrix, BasicNanoTimestampVector, BasicNanoTimeVector, BasicPoint, BasicPointVector, BasicSecond, BasicSecondMatrix, BasicSecondVector, BasicSet, BasicShort, BasicShortMatrix, BasicShortVector, BasicString, BasicStringMatrix, BasicStringVector, BasicSymbolVector, BasicSystemEntity, BasicTable, BasicTableSchema, BasicTime, BasicTimeMatrix, BasicTimestamp, BasicTimestampMatrix, BasicTimestampVector, BasicTimeVector, BasicUuid, BasicUuidVector, EntityBlockReader, Void
```
public interface Entity
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Entity.DATA_CATEGORY`
`static class`	`Entity.DATA_FORM`
`static class`	`Entity.DATA_TYPE`
`static class`	`Entity.DURATION`
`static class`	`Entity.PARTITION_TYPE`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`int`	`columns()`
`Entity.DATA_CATEGORY`	`getDataCategory()`
`Entity.DATA_FORM`	`getDataForm()`
`Entity.DATA_TYPE`	`getDataType()`
`default String`	`getJsonString()`
`default Number`	`getNumber()`
`String`	`getString()`
`default Temporal`	`getTemporal()`
`default int`	`hashBucket(int buckets)`
`boolean`	`isChart()`
`boolean`	`isChunk()`
`boolean`	`isDictionary()`
`boolean`	`isMatrix()`
`default boolean`	`isNull()` Below methods are extract from Scalar interface, include: isNull、setNull、getNumber、getTemporal、hashBucket、getJsonString Purpose: Because new version now is support return Entity, if clients haven't modified old use(eg, use Scalar special method) need to adapt it, so the solution is extract methods from Scalar to its parent interface Entity.
`boolean`	`isPair()`
`boolean`	`isScalar()`
`boolean`	`isTable()`
`boolean`	`isVector()`
`int`	`rows()`
`default void`	`setNull()`
`static Entity.DATA_CATEGORY`	`typeToCategory(Entity.DATA_TYPE type)`
`void`	`write(ExtendedDataOutput output)`
`default void`	`writeCompressed(ExtendedDataOutput output)`

Method Detail

getDataForm
```
Entity.DATA_FORM getDataForm()
```

getDataCategory
```
Entity.DATA_CATEGORY getDataCategory()
```

getDataType
```
Entity.DATA_TYPE getDataType()
```

rows
```
int rows()
```

columns
```
int columns()
```

getString
```
String getString()
```

write

void write(ExtendedDataOutput output)
    throws IOException

Throws:: IOException

writeCompressed

default void writeCompressed(ExtendedDataOutput output)
                      throws IOException

Throws:: IOException

isScalar
```
boolean isScalar()
```

isVector
```
boolean isVector()
```

isPair
```
boolean isPair()
```

isTable
```
boolean isTable()
```

isMatrix
```
boolean isMatrix()
```

isDictionary
```
boolean isDictionary()
```

isChart
```
boolean isChart()
```

isChunk
```
boolean isChunk()
```

typeToCategory

static Entity.DATA_CATEGORY typeToCategory(Entity.DATA_TYPE type)

isNull
```
default boolean isNull()
```
Below methods are extract from Scalar interface, include: isNull、setNull、getNumber、getTemporal、hashBucket、getJsonString Purpose: Because new version now is support return Entity, if clients haven't modified old use(eg, use Scalar special method) need to adapt it, so the solution is extract methods from Scalar to its parent interface Entity.

setNull
```
default void setNull()
```

getNumber

default Number getNumber()
                  throws Exception

Throws:: Exception

getTemporal

default Temporal getTemporal()
                      throws Exception

Throws:: Exception

hashBucket
```
default int hashBucket(int buckets)
```

getJsonString
```
default String getJsonString()
```

Interface Entity

Nested Class Summary

Method Summary

Method Detail

getDataForm

getDataCategory

getDataType

rows

columns

getString

write

writeCompressed

isScalar

isVector

isPair

isTable

isMatrix

isDictionary

isChart

isChunk

typeToCategory

isNull

setNull

getNumber

getTemporal

hashBucket

getJsonString