org.openimaj.hadoop.sequencefile

Enum NamingStrategy

java.lang.Object

java.lang.Enum<NamingStrategy>

org.openimaj.hadoop.sequencefile.NamingStrategy

All Implemented Interfaces:

Serializable, Comparable<NamingStrategy>

public enum NamingStrategy
extends Enum<NamingStrategy>

Strategies for naming files extracted from SequenceFiles.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk), Jonathon Hare (jsh2@ecs.soton.ac.uk)

Enum Constant Summary

Enum Constants

Enum Constant and Description
KEY Use the key value as the filename
NUMERICAL Number the files sequentially

Method Summary

Modifier and Type	Method and Description
<K,V> String	getName(K key, V value, ExtractionState state, boolean addExtension) Generate the filename for the given record (key-value pair).
protected abstract <K,V> String	getNameInternal(K key, V value, ExtractionState state)
static NamingStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static NamingStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

KEY

public static final NamingStrategy KEY

Use the key value as the filename

NUMERICAL

public static final NamingStrategy NUMERICAL

Number the files sequentially

Method Detail

values

public static NamingStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NamingStrategy c : NamingStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NamingStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNameInternal

protected abstract <K,V> String getNameInternal(K key,
                                                V value,
                                                ExtractionState state)

getName

public <K,V> String getName(K key,
                            V value,
                            ExtractionState state,
                            boolean addExtension)

Generate the filename for the given record (key-value pair). If the addExtension flag is true AND the value is a BytesWritable, then a mime-type sniffing process takes place in order to "guess" an extension which will be added to the end of the generated filename.

Type Parameters:

K - key type

V - value type

Parameters:

key - the key

value - the value

state - the extraction state

addExtension - should the file extension be guessed and added automatically

Returns:

the filename