org.kitesdk.data.spi

Class StorageKey

java.lang.Object

org.kitesdk.data.spi.Marker

org.kitesdk.data.spi.StorageKey

All Implemented Interfaces:

Comparable<StorageKey>

public class StorageKey
extends Marker
implements Comparable<StorageKey>

A StorageKey is a complete set of values for a PartitionStrategy.

Since:

0.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageKey.Builder A fluent Builder for creating a StorageKey.

Constructor Summary

Constructors

Constructor and Description
StorageKey(PartitionStrategy strategy)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(StorageKey other)
static StorageKey	copy(StorageKey toCopy) A convenience method to make a copy of a StorageKey.
boolean	equals(Object obj)
Object	get(int index) Returns the value for index.
Object	get(String name) Returns the value for name.
PartitionStrategy	getPartitionStrategy()
Path	getPath()
boolean	has(String name) Returns whether name is stored in this Marker.
int	hashCode()
void	replace(int index, Object value) Replaces the value at index with the given value.
void	replaceValues(List<Object> values) Replaces all of the values in this StorageKey with the given List.
<E> StorageKey	reuseFor(E entity, EntityAccessor<E> accessor) Replaces all of the values in this StorageKey with values from the given entity.
<E> StorageKey	reuseFor(E entity, Map<String,Object> provided, EntityAccessor<E> accessor) Replaces all of the values in this StorageKey with values from the given entity.
StorageKey	reuseFor(List<String> dirs, org.kitesdk.data.spi.filesystem.PathConversion conversion)
StorageKey	reuseFor(Path path, org.kitesdk.data.spi.filesystem.PathConversion conversion)
String	toString()

Methods inherited from class org.kitesdk.data.spi.Marker

getAs, valueFor

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageKey

public StorageKey(PartitionStrategy strategy)

Method Detail

getPartitionStrategy

public PartitionStrategy getPartitionStrategy()

getPath

public Path getPath()

has

public boolean has(String name)

Description copied from class: Marker

Returns whether name is stored in this Marker.

Specified by:

has in class Marker

Parameters:

name - a String name

Returns:

true if there is a value for name

get

public Object get(String name)

Description copied from class: Marker

Returns the value for name.

Specified by:

get in class Marker

Parameters:

name - the String name of the value to return

Returns:

the Object stored for name

get

public Object get(int index)

Returns the value for index.

Parameters:

index - the index of the value to return

Returns:

the Object stored at index

replace

public void replace(int index,
           Object value)

Replaces the value at index with the given value.

Parameters:

index - the index of the field to replace

value - an Object to store at index

replaceValues

public void replaceValues(List<Object> values)

Replaces all of the values in this StorageKey with the given List.

Parameters:

values - a List of values

reuseFor

public <E> StorageKey reuseFor(E entity,
                      EntityAccessor<E> accessor)

Replaces all of the values in this StorageKey with values from the given entity.

Parameters:

entity - an entity to reuse this StorageKey for

Returns:

this updated StorageKey

Throws:

IllegalStateException - If the entity cannot be used to produce a value for each field in the PartitionStrategy

Since:

0.9.0

reuseFor

public <E> StorageKey reuseFor(E entity,
                      @Nullable
                      Map<String,Object> provided,
                      EntityAccessor<E> accessor)

Replaces all of the values in this StorageKey with values from the given entity.

Parameters:

entity - an entity to reuse this StorageKey for

Returns:

this updated StorageKey

Throws:

IllegalStateException - If the entity cannot be used to produce a value for each field in the PartitionStrategy

Since:

0.9.0

reuseFor

public StorageKey reuseFor(List<String> dirs,
                  org.kitesdk.data.spi.filesystem.PathConversion conversion)

reuseFor

public StorageKey reuseFor(Path path,
                  org.kitesdk.data.spi.filesystem.PathConversion conversion)

compareTo

public int compareTo(StorageKey other)

Specified by:

compareTo in interface Comparable<StorageKey>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

copy

public static StorageKey copy(StorageKey toCopy)

A convenience method to make a copy of a StorageKey. This is not a deep copy.

Parameters:

toCopy - a StorageKey to copy

Returns:

a new StorageKey with the same PartitionStrategy and content