Package io.deephaven.proto.pivot

Class PivotTableDescriptorMessage

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

io.deephaven.proto.pivot.PivotTableDescriptorMessage

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, PivotTableDescriptorMessageOrBuilder, Serializable

@Generated
public final class PivotTableDescriptorMessage
extends GeneratedMessage
implements PivotTableDescriptorMessageOrBuilder

Protobuf type io.deephaven.proto.pivot.PivotTableDescriptorMessage

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PivotTableDescriptorMessage.Builder	Protobuf type io.deephaven.proto.pivot.PivotTableDescriptorMessage

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

GeneratedMessage.ExtendableBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, GeneratedMessage.ExtendableMessage<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>, GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingT extends Message,T extends Object>, GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	IS_STATIC_FIELD_NUMBER
static final int	SNAPSHOT_SCHEMA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static PivotTableDescriptorMessage	getDefaultInstance()
PivotTableDescriptorMessage	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
boolean	getIsStatic()	Whether or not this table might change.
Parser<PivotTableDescriptorMessage>	getParserForType()
int	getSerializedSize()
ByteString	getSnapshotSchema()	Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
int	hashCode()
protected GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static PivotTableDescriptorMessage.Builder	newBuilder()
static PivotTableDescriptorMessage.Builder	newBuilder(PivotTableDescriptorMessage prototype)
PivotTableDescriptorMessage.Builder	newBuilderForType()
protected PivotTableDescriptorMessage.Builder	newBuilderForType(AbstractMessage.BuilderParent parent)
static PivotTableDescriptorMessage	parseDelimitedFrom(InputStream input)
static PivotTableDescriptorMessage	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static PivotTableDescriptorMessage	parseFrom(byte[] data)
static PivotTableDescriptorMessage	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static PivotTableDescriptorMessage	parseFrom(ByteString data)
static PivotTableDescriptorMessage	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static PivotTableDescriptorMessage	parseFrom(CodedInputStream input)
static PivotTableDescriptorMessage	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static PivotTableDescriptorMessage	parseFrom(InputStream input)
static PivotTableDescriptorMessage	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static PivotTableDescriptorMessage	parseFrom(ByteBuffer data)
static PivotTableDescriptorMessage	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<PivotTableDescriptorMessage>	parser()
PivotTableDescriptorMessage.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

SNAPSHOT_SCHEMA_FIELD_NUMBER

public static final int SNAPSHOT_SCHEMA_FIELD_NUMBER

See Also:

• Constant Field Values

IS_STATIC_FIELD_NUMBER

public static final int IS_STATIC_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessage

getSnapshotSchema

public ByteString getSnapshotSchema()

 Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
 Field metadata is used to convey additional information about the structure of the PivotTable, the
 special roles some columns play, and the relationships between columns.

 All schema metadata for pivots is prefixed with "deephaven:".  Most values are a boolean tag (represented as the
 string "true" if set that indicate which type of column this is.

 "pivotTable.isStructuralColumn" set on columns that should be included on every snapshot or subscription request,
 but should not be directly user-visible.

 "pivotTable.isRowExpandByColumn" is set on all the columns that must be included in a PivotTableViewRequest's row key table. These columns are generally user-visible and
 displayed before other columns, unless they also have {@value PIVOT_TABLE_IS_STRUCTURAL_COLUMN} set.

 "pivotTable.isRowDepthColumn"  is set on a single column that specifies the depth of
 a row. That column will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowExpandedColumn" is set on a single nullable column of booleans that
 specifies whether a row is expandable or expanded. Values will be null for rows that are not expandable, true for
 expanded rows, false for rows that are not expanded (but expandable). Leaf rows have no children to expand, and
 hence will always have a null value for this column.

 "pivotTable.isRowGroupByColumn" is set on all columns of a pivot that are row
 by-columns Such columns will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowValueColumn" is set on all columns that are totals for a given row.

 The Column dimension has an equivalent set of attributes as rows:
 "pivotTable.isColumnExpandByColumn"
 "pivotTable.isColumnDepthColumn"
 "pivotTable.isColumnExpandedColumn"
 "pivotTable.isColumnGroupByColumn"
 "pivotTable.isColumnValueColumn"

 "pivotTable.isGrandTotalValueColumn" is set on all columns that are a grand total the given  table.  These columns
 have only one value for the entire snapshot that represents the aggregation across the entire source table.

 "pivotTable.isValueColumn" is set on all columns that are part of the main field (grid) of values.

 "pivotTable.aggregationInputColumnName" is set to the name of the corresponding constituent column that
 was used as input to this column. May have an empty value, because some aggregations take no input columns, for
 example, "Count". This is only ever present on columns with "pivotTable.isValueColumn"
 "pivotTable.isRowValueColumn",  "pivotTable.isColumnValueColumn" or "pivotTable.isGrandTotalValueColumn" set.
 

bytes snapshot_schema = 1;

Specified by:

getSnapshotSchema in interface PivotTableDescriptorMessageOrBuilder

Returns:

The snapshotSchema.

getIsStatic

public boolean getIsStatic()

 Whether or not this table might change.
 

bool is_static = 2;

Specified by:

getIsStatic in interface PivotTableDescriptorMessageOrBuilder

Returns:

The isStatic.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static PivotTableDescriptorMessage parseFrom(ByteBuffer data)
                                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PivotTableDescriptorMessage parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PivotTableDescriptorMessage parseFrom(ByteString data)
                                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PivotTableDescriptorMessage parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PivotTableDescriptorMessage parseFrom(byte[] data)
                                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PivotTableDescriptorMessage parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PivotTableDescriptorMessage parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static PivotTableDescriptorMessage parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static PivotTableDescriptorMessage parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static PivotTableDescriptorMessage parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:

IOException

parseFrom

public static PivotTableDescriptorMessage parseFrom(CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static PivotTableDescriptorMessage parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

newBuilderForType

public PivotTableDescriptorMessage.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static PivotTableDescriptorMessage.Builder newBuilder()

newBuilder

public static PivotTableDescriptorMessage.Builder newBuilder(PivotTableDescriptorMessage prototype)

toBuilder

public PivotTableDescriptorMessage.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected PivotTableDescriptorMessage.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class AbstractMessage

getDefaultInstance

public static PivotTableDescriptorMessage getDefaultInstance()

parser

public static Parser<PivotTableDescriptorMessage> parser()

getParserForType

public Parser<PivotTableDescriptorMessage> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

getDefaultInstanceForType

public PivotTableDescriptorMessage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder