Package io.deephaven.proto.pivot

Class PivotTableDescriptorMessage

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.deephaven.proto.pivot.PivotTableDescriptorMessage

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, PivotTableDescriptorMessageOrBuilder, Serializable

public final class PivotTableDescriptorMessage
extends GeneratedMessageV3
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.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, GeneratedMessageV3.ExtendableMessage<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

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.GeneratedMessageV3

alwaysUseFieldBuilders, 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)	Compares the specified object with this message for equality.
static PivotTableDescriptorMessage	getDefaultInstance()
PivotTableDescriptorMessage	getDefaultInstanceForType()	Get an instance of the type with no fields set.
static final Descriptors.Descriptor	getDescriptor()
boolean	getIsStatic()	Whether or not this table might change.
Parser<PivotTableDescriptorMessage>	getParserForType()	TODO: Remove this unnecessary intermediate implementation of this method.
int	getSerializedSize()	Get the number of bytes required to encode this message.
ByteString	getSnapshotSchema()	Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
int	hashCode()	Returns the hash code value for this message.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
final boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static PivotTableDescriptorMessage.Builder	newBuilder()
static PivotTableDescriptorMessage.Builder	newBuilder(PivotTableDescriptorMessage prototype)
PivotTableDescriptorMessage.Builder	newBuilderForType()	Constructs a new builder for a message of the same type as this message.
protected PivotTableDescriptorMessage.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)	TODO: remove this together with GeneratedMessageV3.BuilderParent.
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)	Creates a new instance of this message type.
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()	Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output)	Serializes the message and writes it to output.

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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

getAllFields, getDescriptorForType, getField, 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

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Description copied from class: com.google.protobuf.GeneratedMessageV3

Creates a new instance of this message type. Overridden in the generated code.

Overrides:

newInstance in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: com.google.protobuf.GeneratedMessageV3

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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()

Description copied from interface: com.google.protobuf.MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder#getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Description copied from interface: com.google.protobuf.MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: com.google.protobuf.MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.

Specified by:

getSerializedSize in interface MessageLite

equals

public boolean equals(Object obj)

Description copied from interface: com.google.protobuf.Message

Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

Parameters:

obj - object to be compared for equality with this message

Returns:

true if the specified object is equal to this message

hashCode

public int hashCode()

Description copied from interface: com.google.protobuf.Message

Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

Returns:

the hash code value for this message

See Also:

• Map.hashCode()

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()

Description copied from interface: com.google.protobuf.MessageLite

Constructs a new builder for a message of the same type as this message.

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()

Description copied from interface: com.google.protobuf.MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected PivotTableDescriptorMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Description copied from class: com.google.protobuf.GeneratedMessageV3

TODO: remove this together with GeneratedMessageV3.BuilderParent.

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static PivotTableDescriptorMessage getDefaultInstance()

parser

public static Parser<PivotTableDescriptorMessage> parser()

getParserForType

public Parser<PivotTableDescriptorMessage> getParserForType()

Description copied from class: com.google.protobuf.GeneratedMessageV3

TODO: Remove this unnecessary intermediate implementation of this method.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public PivotTableDescriptorMessage getDefaultInstanceForType()

Description copied from interface: com.google.protobuf.MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder