/** Configuration keys used by FijiMR in Hadoop Configuration objects. */ @ApiAudience.Public @ApiStability.Evolving @Deprecated public final class FijiConfKeys { /** URI of the input table to read from. */ public static final String INPUT_TABLE_URI = "fiji.input.table.uri"; /** URI of the output Fiji table to write to. */ public static final String OUTPUT_FIJI_TABLE_URI = "fiji.output.table.uri"; /** Serialized input data request. */ public static final String INPUT_DATA_REQUEST = "fiji.input.request"; /** Utility class may not be instantiated. */ private FijiConfKeys() { } }
/** * Thrown when there is an attempt to operate on a Fiji instance whose data format version * is incompatible with the Fiji client version. */ @ApiAudience.Public @ApiStability.Stable public final class IncompatibleFijiVersionException extends IOException { /** * Creates a new <code>IncompatibleFijiVersionException</code> with the specified * detail message. * * @param message The exception message. */ public IncompatibleFijiVersionException(String message) { super(message); } }
/** * An object available to FijiColumnFilters that can be used to help implement the * toHBaseFilter() method. */ @ApiAudience.Public @Inheritance.Sealed public abstract static class Context { /** * Converts a Fiji column name to an HBase column name. * * @param fijiColumnName The name of a fiji column. * @return The name of the HBase column that stores the fiji column data. * @throws NoSuchColumnException If there is no such column in the fiji table. */ public abstract HBaseColumnName getHBaseColumnName(FijiColumnName fijiColumnName) throws NoSuchColumnException; }
/** * Base class for Fiji reducer. * * @param <INKEY> The type of the input key to the mapper. * @param <INVALUE> The type of the input value to the mapper. * @param <OUTKEY> The type of the output key from the mapper. * @param <OUTVALUE> The type of the output value from the mapper. */ @ApiAudience.Public @ApiStability.Stable @Inheritance.Extensible public abstract class FijiReducer<INKEY, INVALUE, OUTKEY, OUTVALUE> extends Reducer<INKEY, INVALUE, OUTKEY, OUTVALUE> implements KVOutputJob { }
/** * Thrown when attempting to access a column that does not exist. */ @ApiAudience.Public @ApiStability.Stable public final class NoSuchColumnException extends IOException { /** * Creates a new <code>NoSuchColumnException</code> with the specified detail message. * * @param message The exception message. */ public NoSuchColumnException(String message) { super(message); } }
/** * An object representing a partition of a Fiji table. * * <p> * A Fiji partition may be used to scan over a contiguous group of rows in a Fiji table in an * efficient manner. * </p> * * <p> * In general, it is not possible to know whether any given Fiji row is contained within a * partition, because of hashing and differences in underlying storage mechanisms. Therefore, * Fiji partitions are typically only useful for performing whole-table scans in parallel. * </p> */ @ApiAudience.Public @ApiStability.Experimental public interface FijiPartition { }
/** * Thrown when a Fiji table layout has a schema class reference that cannot be loaded * (probably because it is not on the class path). */ @ApiAudience.Public @ApiStability.Stable public final class SchemaClassNotFoundException extends InvalidLayoutException { /** * Creates a new <code>SchemaClassNotFoundException</code> with the specified detail message.. * * @param message The exception message. */ public SchemaClassNotFoundException(String message) { super(message); } }
/** * Thrown when fiji encounters a row key component name that is not valid. */ @ApiAudience.Public @ApiStability.Stable @Inheritance.Sealed public class EntityIdException extends RuntimeException { /** * Creates a new <code>EntityIdException</code> with the specified detail message. * * @param message The exception message. */ public EntityIdException(String message) { super(message); } }
/** * Base class for Fiji mappers. * * @param <INKEY> The type of the input key to the mapper. * @param <INVALUE> The type of the input value to the mapper. * @param <OUTKEY> The type of the output key from the mapper. * @param <OUTVALUE> The type of the output value from the mapper. */ @ApiAudience.Public @ApiStability.Stable @Inheritance.Extensible public abstract class FijiMapper<INKEY, INVALUE, OUTKEY, OUTVALUE> extends Mapper<INKEY, INVALUE, OUTKEY, OUTVALUE> implements KVOutputJob { }
/** * Thrown when attempting to read data from a cell that doesn't exist. */ @ApiAudience.Public @ApiStability.Stable public final class NoCellDataException extends Exception { /** * Creates a new <code>NoCellDataException</code> with the specified detail message. * * @param message The exception message. */ public NoCellDataException(String message) { super(message); } }
/** * Thrown when an invalid Fiji table import descriptor is encountered. * A table import descriptor is invalid when either the columns specified in either the source * or the destination don't exist. */ @ApiAudience.Public public class InvalidTableImportDescriptorException extends IOException { /** * Creates a new <code>InvalidTableImportDescriptorException</code> with the specified reason. * * @param reason A message describing the reason the mapping is invalid. */ public InvalidTableImportDescriptorException(String reason) { super(reason); } }
/** Context for Fiji bulk-importers or reducers to output to a Fiji table. */ @ApiAudience.Public @ApiStability.Stable @Inheritance.Sealed public interface FijiTableContext extends FijiContext, FijiPutter, FijiDeleter { /** @return a factory to create entity IDs to write to the output Fiji table. */ EntityIdFactory getEntityIdFactory(); /** * Creates an entity ID for the specified Fiji row key. * * @param components Fiji row key components. * @return the entity ID for the specified Fiji row key. */ EntityId getEntityId(Object... components); }
/** * Exception thrown during a metadata restore operation due to user error. */ @ApiAudience.Public @ApiStability.Stable final class RestoreException extends Exception { /** * Creates a new RestoreException instance, with the specified message. A user-readable * message must be specified with this exception type. * @param msg the message to include. */ RestoreException(String msg) { super(msg); } }
/** * Thrown when a user attempts an action he or she does not have access to. */ @ApiAudience.Public @ApiStability.Stable public final class FijiAccessException extends RuntimeException { /** * Creates a new <code>FijiAccessException</code> with the specified detail message. * * @param message The exception message. */ public FijiAccessException(String message) { super(message); } }
/** * Thrown when a Fiji instance or table layout name is invalid. */ @ApiAudience.Public @ApiStability.Stable public final class FijiInvalidNameException extends RuntimeException { /** * Creates a new <code>FijiInvalidNameException</code> with the specified detail message. * * @param message The exception message. */ public FijiInvalidNameException(String message) { super(message); } }
/** * Thrown when there is an error validating a FijiDataRequest against a Fiji table. */ @ApiAudience.Public @ApiStability.Stable public final class FijiDataRequestException extends RuntimeException { /** * Creates a new <code>FijiDataRequestException</code> with the specified detail message. * * @param message The exception message. */ public FijiDataRequestException(String message) { super(message); } }
/** * Thrown when an attempt to get a table connection fails because there is no room in the pool. */ @ApiAudience.Public public static final class NoCapacityException extends IOException { /** * Creates a new <code>NoCapacityException</code> with the specified detail message. * @param message The exception message. */ public NoCapacityException(String message) { super(message); } }
/** Thrown when a MapReduceJob is being built, but it has missing or incomplete configuration. */ @ApiAudience.Public @ApiStability.Stable public final class JobConfigurationException extends RuntimeException { /** * Creates a new <code>JobConfigurationException</code> instance. * * @param message A detailed message describing the exception. */ public JobConfigurationException(String message) { super(message); } }
/** Thrown when a FijiProducer fails to produce output. */ @ApiAudience.Public @ApiStability.Stable public final class FijiProducerOutputException extends IOException { /** * Creates a new <code>FijiProducerOutputException</code> instance. * * @param message An exception message. */ public FijiProducerOutputException(String message) { super(message); } }
/** Configuration keys used by Cassandra FijiMR in Hadoop Configuration objects. */ @ApiAudience.Public @ApiStability.Evolving public final class CassandraFijiConfKeys { private static final Logger LOG = LoggerFactory.getLogger(CassandraFijiConfKeys.class); /** Desired number of input splits. */ public static final String TARGET_NUMBER_OF_CASSANDRA_INPUT_SPLITS = "fiji.input.splits.target"; /** Utility class may not be instantiated. */ private CassandraFijiConfKeys() { } }