org.openimaj.hadoop.tools.sequencefile

Enum ListModeOptions

java.lang.Object

java.lang.Enum<ListModeOptions>

org.openimaj.hadoop.tools.sequencefile.ListModeOptions

All Implemented Interfaces:

Serializable, Comparable<ListModeOptions>

public enum ListModeOptions
extends Enum<ListModeOptions>

Options for controlling what is printed when listing the contents of a SequenceFile with the SequenceFileTool.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
IMAGE_DIMENSIONS Print the dimensions of each records value if it is a valid image.
KEY Print the record key
MIMETYPE Print the mimetype of the value in each record
OFFSET Print the offset of the record in the SequenceFile
SEQUENCEFILE Print the path to the SequenceFile in question.
SIZE Print the size of the record value in bytes

Method Summary

Modifier and Type	Method and Description
abstract RecordInformationExtractor	getExtractor()
static List<RecordInformationExtractor>	listOptionsToExtractPolicy(List<ListModeOptions> options) Construct a list of extractors from the given options.
static ListModeOptions	valueOf(String name) Returns the enum constant of this type with the specified name.
static ListModeOptions[]	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 ListModeOptions KEY

Print the record key

OFFSET

public static final ListModeOptions OFFSET

Print the offset of the record in the SequenceFile

SEQUENCEFILE

public static final ListModeOptions SEQUENCEFILE

Print the path to the SequenceFile in question. This is useful if you're working with a directory of SequenceFiles

MIMETYPE

public static final ListModeOptions MIMETYPE

Print the mimetype of the value in each record

SIZE

public static final ListModeOptions SIZE

Print the size of the record value in bytes

IMAGE_DIMENSIONS

public static final ListModeOptions IMAGE_DIMENSIONS

Print the dimensions of each records value if it is a valid image.

Method Detail

values

public static ListModeOptions[] 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 (ListModeOptions c : ListModeOptions.values())
    System.out.println(c);

Returns:

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

valueOf

public static ListModeOptions 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

getExtractor

public abstract RecordInformationExtractor getExtractor()

Returns:

a RecordInformationExtractor for extracting information from a SequenceFile record.

listOptionsToExtractPolicy

public static List<RecordInformationExtractor> listOptionsToExtractPolicy(List<ListModeOptions> options)

Construct a list of extractors from the given options.

Parameters:

options - the options

Returns:

the extractors in the same order as the given options