AbstractDataset (Kite Data Core Module 1.1.0 API)

java.lang.Object
- org.kitesdk.data.spi.AbstractDataset<E>

Type Parameters:
E - The type of entities stored in this Dataset.

All Implemented Interfaces:

Dataset<E>, RefinableView<E>, View<E>
```
@Immutable
public abstract class AbstractDataset<E>
extends Object
implements Dataset<E>, RefinableView<E>
```
A common Dataset base class to simplify implementations.

Since:

0.9.0

Field Summary

Fields
Modifier and Type Field and Description

protected Schema schema

protected Class<E> type

Fields
Modifier and Type	Field and Description
`protected Schema`	`schema`
`protected Class<E>`	`type`

Constructor Summary

Constructors
Constructor and Description

AbstractDataset(Class<E> type, Schema schema)

Constructors
Constructor and Description
`AbstractDataset(Class<E> type, Schema schema)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract RefinableView<E>`	`asRefinableView()`
`View<GenericRecord>`	`asSchema(Schema schema)` Creates a copy of this `View` that projects entities to the given `Schema`.
`<T> Dataset<T>`	`asType(Class<T> type)` Creates a copy of this `Dataset` that reads and writes entities of the given type class.
`boolean`	`deleteAll()` Deletes the entities included in this `View` or throws an `UnsupportedOperationException`.
`boolean`	`equals(Object obj)`
`abstract AbstractRefinableView<E>`	`filter(Constraints c)`
`RefinableView<E>`	`from(String name, Comparable value)` Creates a sub-`View`, restricted to entities whose `name` field is greater than or equal to the given `value`.
`RefinableView<E>`	`fromAfter(String name, Comparable value)` Creates a sub-`View`, restricted to entities whose `name` field is greater than the given `value`.
`Iterable<PartitionView<E>>`	`getCoveringPartitions()` Returns an `Iterable` of non-overlapping `View` objects that partition the underlying `Dataset` and cover this `View`.
`Dataset<E>`	`getDataset()` Returns the underlying `Dataset` for the `View`.
`Schema`	`getSchema()` Get the schema of entities contained in this `View`.
`Class<E>`	`getType()` Get the runtime type of entities contained in this `View`.
`int`	`hashCode()`
`boolean`	`includes(E entity)` Returns whether an entity `Object` would be included in this `View` if it were present in the `Dataset`.
`DatasetReader<E>`	`newReader()` Get an appropriate `DatasetReader` implementation based on this `View` of the underlying `Dataset` implementation.
`DatasetWriter<E>`	`newWriter()` Get an appropriate `DatasetWriter` implementation based on this `View` of the underlying `Dataset` implementation.
`RefinableView<E>`	`to(String name, Comparable value)` Creates a sub-`View`, restricted to entities whose `name` field is less than or equal to the given `value`.
`RefinableView<E>`	`toBefore(String name, Comparable value)` Creates a sub-`View`, restricted to entities whose `name` field is less than the given `value`.
`RefinableView<E>`	`with(String name, Object... values)` Creates a sub-`View`, restricted to entities whose `name` field is equal to any of the given `values`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kitesdk.data.Dataset
getDescriptor, getName, getNamespace, getUri

Methods inherited from interface org.kitesdk.data.View
isEmpty

- Field Detail
  - type
```
protected final Class<E> type
```
  - schema
```
protected final Schema schema
```
- Constructor Detail
  - AbstractDataset
```
public AbstractDataset(Class<E> type,
               Schema schema)
```
- Method Detail
  - asRefinableView
```
protected abstract RefinableView<E> asRefinableView()
```
  - getDataset
```
public Dataset<E> getDataset()
```
    Description copied from interface: View
    
    Returns the underlying Dataset for the View.
    
    Specified by:
    
    getDataset in interface View<E>
    
    Returns:
    the underlying Dataset
  - filter
```
public abstract AbstractRefinableView<E> filter(Constraints c)
```
  - asType
```
public <T> Dataset<T> asType(Class<T> type)
```
    Creates a copy of this Dataset that reads and writes entities of the given type class.
    
    Specified by:
    
    asType in interface View<E>
    
    Type Parameters:
    T - The type of entities that will be read or written by this dataset.
    Parameters:
    type - an entity class to use
    
    Returns:
    a copy of this view that projects entities to the given type
    
    Throws:
    
    IncompatibleSchemaException - If the given type is incompatible with the underlying dataset.
  - newWriter
```
public DatasetWriter<E> newWriter()
```
    Description copied from interface: View
    
    Get an appropriate DatasetWriter implementation based on this View of the underlying Dataset implementation. Implementations are free to return different types of writers depending on the disposition of the data. For example, a partitioned dataset may use a different writer than that of a non-partitioned dataset. Clients should not make any assumptions about the returned implementations: implementations are free to change their internal structure at any time.
    
    Specified by:
    
    newWriter in interface View<E>
  - newReader
```
public DatasetReader<E> newReader()
```
    Description copied from interface: View
    
    Get an appropriate DatasetReader implementation based on this View of the underlying Dataset implementation. Implementations are free to return different types of readers, depending on the disposition of the data. For example, a partitioned dataset can use a different reader than that of a non-partitioned dataset. Clients should not make any assumptions about the returned implementations: implementations are free to change their internal structure at any time.
    
    Specified by:
    
    newReader in interface View<E>
  - getCoveringPartitions
```
public Iterable<PartitionView<E>> getCoveringPartitions()
```
    Description copied from interface: View
    
    Returns an Iterable of non-overlapping View objects that partition the underlying Dataset and cover this View. The returned View objects are implementation-specific, but should represent reasonable partitions of the underlying Dataset based on its layout. The data contained by the union of each View in the Iterable must be a super-set of this View. Note that partitions are actual partitions under which data is stored. Implementations should omit any View that is empty.
    
    Specified by:
    
    getCoveringPartitions in interface View<E>
    
    Returns:
    An Iterable of the View that cover this View.
  - includes
```
public boolean includes(E entity)
```
    Description copied from interface: View
    
    Returns whether an entity Object would be included in this View if it were present in the Dataset.
    
    Specified by:
    
    includes in interface View<E>
    
    Parameters:
    entity - an entity Object
    
    Returns:
    true if entity is in the partition space of this view.
  - getType
```
public Class<E> getType()
```
    Description copied from interface: View
    
    Get the runtime type of entities contained in this View.
    
    Specified by:
    
    getType in interface View<E>
    
    Returns:
    the runtime type of entities contained in this view
  - getSchema
```
public Schema getSchema()
```
    Description copied from interface: View
    
    Get the schema of entities contained in this View.
    
    Specified by:
    
    getSchema in interface View<E>
    
    Returns:
    the schema of entities contained in this view
  - with
```
public RefinableView<E> with(String name,
                    Object... values)
```
    Description copied from interface: RefinableView
    
    Creates a sub-View, restricted to entities whose name field is equal to any of the given values. If you specify no values, the view is restricted to entities whose name field is non-null.
    
    Specified by:
    
    with in interface RefinableView<E>
    
    Parameters:
    name - the field name of the entity
    
    Returns:
    the restricted view
  - from
```
public RefinableView<E> from(String name,
                    Comparable value)
```
    Description copied from interface: RefinableView
    
    Creates a sub-View, restricted to entities whose name field is greater than or equal to the given value.
    
    Specified by:
    
    from in interface RefinableView<E>
    
    Parameters:
    name - the field name of the entity
    
    Returns:
    the restricted view
  - fromAfter
```
public RefinableView<E> fromAfter(String name,
                         Comparable value)
```
    Description copied from interface: RefinableView
    
    Creates a sub-View, restricted to entities whose name field is greater than the given value.
    
    Specified by:
    
    fromAfter in interface RefinableView<E>
    
    Parameters:
    name - the field name of the entity
    
    Returns:
    the restricted view
  - to
```
public RefinableView<E> to(String name,
                  Comparable value)
```
    Description copied from interface: RefinableView
    
    Creates a sub-View, restricted to entities whose name field is less than or equal to the given value.
    
    Specified by:
    
    to in interface RefinableView<E>
    
    Parameters:
    name - the field name of the entity
    
    Returns:
    the restricted view
  - toBefore
```
public RefinableView<E> toBefore(String name,
                        Comparable value)
```
    Description copied from interface: RefinableView
    
    Creates a sub-View, restricted to entities whose name field is less than the given value.
    
    Specified by:
    
    toBefore in interface RefinableView<E>
    
    Parameters:
    name - the field name of the entity
    
    Returns:
    the restricted view
  - asSchema
```
public View<GenericRecord> asSchema(Schema schema)
```
    Description copied from interface: View
    
    Creates a copy of this View that projects entities to the given Schema.
    This method always returns a View with type GenericRecord.
    
    Specified by:
    
    asSchema in interface View<E>
    
    Parameters:
    schema - an Avro schema to project entities to
    
    Returns:
    a copy of this view that projects entities to the given schema
  - deleteAll
```
public boolean deleteAll()
```
    Description copied from interface: View
    
    Deletes the entities included in this View or throws an UnsupportedOperationException. Implementations are allowed to throw UnsupportedOperationException if the View could require additional work to delete. For example, if some but not all of the data in an underlying data file must be removed, then the implementation is allowed to reject the deletion rather than copy the remaining records to a new file. Implementations must document what deletes are supported and under what conditions deletes are rejected.
    
    Specified by:
    
    deleteAll in interface View<E>
    
    Returns:
    true if any data was deleted, false if the View was already empty
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AbstractDataset<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.kitesdk.data.Dataset

Methods inherited from interface org.kitesdk.data.View

Field Detail

type

schema

Constructor Detail

AbstractDataset

Method Detail

asRefinableView

getDataset

filter

asType

newWriter

newReader

getCoveringPartitions

includes

getType

getSchema

with

from

fromAfter

to

toBefore

asSchema

deleteAll

equals

hashCode