public final class RecordMetadata extends Object implements PortMetadata
RecordPort
for creating, modifying,
and examining record metadata.Constructor and Description |
---|
RecordMetadata(RecordTokenType type)
Create a RecordMetadata of the given type and unspecified ordering and partitioning.
|
RecordMetadata(RecordTokenType type,
DataOrdering dataOrdering,
DataDistribution dataDistribution)
Create a RecordMetadata of the given type, ordering, and distribution.
|
Modifier and Type | Method and Description |
---|---|
RecordMetadata |
distributed(DataDistribution dataDistribution)
Returns a new RecordMetadata, equivalent to this, but
with dataDistribution set to the specified value.
|
DataDistribution |
getDataDistribution()
Returns the data partitioning of the record port.
|
DataOrdering |
getDataOrdering()
Returns the data ordering of the record port.
|
LogicalPortFactory<?> |
getPortFactory()
Public only as a matter of implementation; not intended for external use.
|
DatasetOptions |
getStagingOptions()
Returns the staging options of the record port.
|
RecordTokenType |
getType()
Returns the type of the record.
|
RecordMetadata |
mutating(List<String> modifiedFields)
Computes the resulting metadata assuming that the specified fields
may be mutated.
|
RecordMetadata |
ordered(DataOrdering dataOrdering)
Returns a new RecordMetadata, equivalent to this, but
with ordering set to the specified value.
|
RecordMetadata |
remap(FieldRemapping mapping)
Computes the resulting metadata after applying the specified schema
remapping.
|
RecordMetadata |
stagingOptions(DatasetOptions stagingOptions)
Returns a new RecordMetadata, equivalent to this, but
with stagingOptions set to the specified value.
|
public RecordMetadata(RecordTokenType type)
type
- the record typepublic RecordMetadata(RecordTokenType type, DataOrdering dataOrdering, DataDistribution dataDistribution)
type
- the record typedataOrdering
- the data orderingdataDistribution
- the data distributionpublic RecordTokenType getType()
public DataOrdering getDataOrdering()
public DataDistribution getDataDistribution()
public DatasetOptions getStagingOptions()
public RecordMetadata ordered(DataOrdering dataOrdering)
dataOrdering
- the new orderingpublic RecordMetadata distributed(DataDistribution dataDistribution)
dataDistribution
- the new distributionpublic RecordMetadata stagingOptions(DatasetOptions stagingOptions)
stagingOptions
- the new staging options.public RecordMetadata remap(FieldRemapping mapping)
This method assumes the values of fields are not being modified and that the relative ordering of records in the flow is unchanged.
mapping
- the remapping to apply to the schemapublic RecordMetadata mutating(List<String> modifiedFields)
This methods assumes that both the underlying schema and the relative ordering of records in the flow is unchanged.
modifiedFields
- the fields that may be modifiedpublic LogicalPortFactory<?> getPortFactory()
PortMetadata
getPortFactory
in interface PortMetadata
Copyright © 2016 Actian Corporation. All rights reserved.