AbstractRefinableView (Kite Data Core Module 1.1.0 API)

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

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

All Implemented Interfaces:

RefinableView<E>, View<E>
```
@Immutable
public abstract class AbstractRefinableView<E>
extends Object
implements RefinableView<E>
```
A common View base class to simplify implementations of Views created from ranges.

Since:

0.9.0

Field Summary

Fields
Modifier and Type	Field and Description
`protected EntityAccessor<E>`	`accessor`
`protected boolean`	`canRead`
`protected boolean`	`canWrite`
`protected MarkerComparator`	`comparator`
`protected Constraints`	`constraints`
`protected Dataset<E>`	`dataset`
`protected com.google.common.base.Predicate<E>`	`entityTest`
`protected ThreadLocal<StorageKey>`	`keys`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractRefinableView(AbstractRefinableView<?> view, Schema schema, Class<E> type)`
`protected`	`AbstractRefinableView(AbstractRefinableView<E> view, Constraints constraints)`
`protected`	`AbstractRefinableView(Dataset<E> dataset, Class<E> type)`

Method Summary

Methods
Modifier and Type	Method and Description
`AbstractRefinableView<GenericRecord>`	`asSchema(Schema schema)` Creates a copy of this `View` that projects entities to the given `Schema`.
`<T> View<T>`	`asType(Class<T> type)` Creates a copy of this `View` that reads and writes entities of the given type class.
`protected void`	`checkSchemaForRead()`
`protected void`	`checkSchemaForWrite()`
`boolean`	`deleteAll()` Deletes the entities included in this `View` or throws an `UnsupportedOperationException`.
`boolean`	`equals(Object o)`
`protected abstract AbstractRefinableView<E>`	`filter(Constraints c)`
`AbstractRefinableView<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`.
`AbstractRefinableView<E>`	`fromAfter(String name, Comparable value)` Creates a sub-`View`, restricted to entities whose `name` field is greater than the given `value`.
`EntityAccessor<E>`	`getAccessor()`
`Constraints`	`getConstraints()`
`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`.
`protected com.google.common.base.Predicate<StorageKey>`	`getKeyPredicate()`
`Map<String,Object>`	`getProvidedValues()`
`Schema`	`getSchema()` Get the schema of entities contained in this `View`.
`Class<E>`	`getType()` Get the runtime type of entities contained in this `View`.
`URI`	`getUri()` Get a `URI` that identifies 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`.
`boolean`	`isEmpty()` Check whether this `View` contains any records.
`protected abstract <T> AbstractRefinableView<T>`	`project(Schema schema, Class<T> type)`
`AbstractRefinableView<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`.
`AbstractRefinableView<E>`	`toBefore(String name, Comparable value)` Creates a sub-`View`, restricted to entities whose `name` field is less than the given `value`.
`String`	`toString()`
`AbstractRefinableView<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, wait, wait, wait

Methods inherited from interface org.kitesdk.data.View
newReader, newWriter

- Field Detail
  - dataset
```
protected final Dataset<E> dataset
```
  - comparator
```
protected final MarkerComparator comparator
```
  - constraints
```
protected final Constraints constraints
```
  - accessor
```
protected final EntityAccessor<E> accessor
```
  - entityTest
```
protected final com.google.common.base.Predicate<E> entityTest
```
  - canRead
```
protected final boolean canRead
```
  - canWrite
```
protected final boolean canWrite
```
  - keys
```
protected final ThreadLocal<StorageKey> keys
```
- Constructor Detail
  - AbstractRefinableView
```
protected AbstractRefinableView(Dataset<E> dataset,
                     Class<E> type)
```
  - AbstractRefinableView
```
protected AbstractRefinableView(AbstractRefinableView<?> view,
                     Schema schema,
                     Class<E> type)
```
  - AbstractRefinableView
```
protected AbstractRefinableView(AbstractRefinableView<E> view,
                     Constraints constraints)
```
- Method Detail
  - getConstraints
```
public Constraints getConstraints()
```
  - filter
```
protected abstract AbstractRefinableView<E> filter(Constraints c)
```
  - project
```
protected abstract <T> AbstractRefinableView<T> project(Schema schema,
                                   Class<T> type)
```
  - 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
  - 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
  - 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
  - getAccessor
```
public EntityAccessor<E> getAccessor()
```
  - getProvidedValues
```
public Map<String,Object> getProvidedValues()
```
  - 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.
  - with
```
public AbstractRefinableView<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 AbstractRefinableView<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 AbstractRefinableView<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 AbstractRefinableView<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 AbstractRefinableView<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 AbstractRefinableView<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
  - asType
```
public <T> View<T> asType(Class<T> type)
```
    Description copied from interface: View
    
    Creates a copy of this View 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 view
    Parameters:
    type - an entity class to use
    
    Returns:
    a copy of this view that projects entities to the given type
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: View
    
    Check whether this View contains any records. Implementations should return once a single record in this view is found. But this might require scanning through large amounts of data sequentially to determine if there are any records.
    
    Specified by:
    
    isEmpty in interface View<E>
    
    Returns:
    true if least one record exists, false otherwise
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getUri
```
public URI getUri()
```
    Description copied from interface: View
    
    Get a URI that identifies this View.
    
    Specified by:
    
    getUri in interface View<E>
    
    Returns:
    a URI for this view.
  - getKeyPredicate
```
protected com.google.common.base.Predicate<StorageKey> getKeyPredicate()
```
  - checkSchemaForWrite
```
protected void checkSchemaForWrite()
```
  - checkSchemaForRead
```
protected void checkSchemaForRead()
```

Class AbstractRefinableView<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.kitesdk.data.View

Field Detail

dataset

comparator

constraints

accessor

entityTest

canRead

canWrite

keys

Constructor Detail

AbstractRefinableView

AbstractRefinableView

AbstractRefinableView

Method Detail

getConstraints

filter

project

getDataset

deleteAll

getType

getSchema

getAccessor

getProvidedValues

getCoveringPartitions

includes

with

from

fromAfter

to

toBefore

asSchema

asType

isEmpty

equals

hashCode

toString

getUri

getKeyPredicate

checkSchemaForWrite

checkSchemaForRead