org.apache.hadoop.io

Class MapFile.Writer

java.lang.Object

org.apache.hadoop.io.MapFile.Writer

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ArrayFile.Writer, BloomMapFile.Writer, SetFile.Writer

Enclosing class:

MapFile

public static class MapFile.Writer
extends Object
implements Closeable

Writes a new map.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapFile.Writer.Option

Constructor Summary

Constructors

Constructor and Description
Writer(Configuration conf, FileSystem fs, String dirName, Class<? extends WritableComparable> keyClass, Class valClass) Deprecated. Use Writer(Configuration, Path, Option...) instead.
Writer(Configuration conf, FileSystem fs, String dirName, Class<? extends WritableComparable> keyClass, Class valClass, SequenceFile.CompressionType compress) Deprecated. Use Writer(Configuration, Path, Option...) instead.
Writer(Configuration conf, FileSystem fs, String dirName, Class<? extends WritableComparable> keyClass, Class valClass, SequenceFile.CompressionType compress, CompressionCodec codec, Progressable progress) Deprecated. Use Writer(Configuration, Path, Option...) instead.
Writer(Configuration conf, FileSystem fs, String dirName, Class<? extends WritableComparable> keyClass, Class valClass, SequenceFile.CompressionType compress, Progressable progress) Deprecated. Use Writer(Configuration, Path, Option...) instead.
Writer(Configuration conf, FileSystem fs, String dirName, WritableComparator comparator, Class valClass) Deprecated. Use Writer(Configuration, Path, Option...) instead.
Writer(Configuration conf, FileSystem fs, String dirName, WritableComparator comparator, Class valClass, SequenceFile.CompressionType compress) Deprecated. Use Writer(Configuration, Path, Option...) instead.
Writer(Configuration conf, FileSystem fs, String dirName, WritableComparator comparator, Class valClass, SequenceFile.CompressionType compress, CompressionCodec codec, Progressable progress) Deprecated. Use Writer(Configuration, Path, Option...) instead.
Writer(Configuration conf, FileSystem fs, String dirName, WritableComparator comparator, Class valClass, SequenceFile.CompressionType compress, Progressable progress) Deprecated. Use Writer(Configuration, Path, Option...)} instead.
Writer(Configuration conf, Path dirName, SequenceFile.Writer.Option... opts)

Method Summary

Modifier and Type	Method and Description
void	append(WritableComparable key, Writable val) Append a key/value pair to the map.
void	close() Close the map.
static MapFile.Writer.Option	comparator(WritableComparator value)
static SequenceFile.Writer.Option	compression(SequenceFile.CompressionType type)
static SequenceFile.Writer.Option	compression(SequenceFile.CompressionType type, CompressionCodec codec)
int	getIndexInterval() The number of entries that are added before an index entry is added.
static MapFile.Writer.Option	keyClass(Class<? extends WritableComparable> value)
static SequenceFile.Writer.Option	progressable(Progressable value)
static void	setIndexInterval(Configuration conf, int interval) Sets the index interval and stores it in conf.
void	setIndexInterval(int interval) Sets the index interval.
static SequenceFile.Writer.Option	valueClass(Class<?> value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Writer

@Deprecated
public Writer(Configuration conf,
                          FileSystem fs,
                          String dirName,
                          Class<? extends WritableComparable> keyClass,
                          Class valClass)
                   throws IOException

Deprecated. Use Writer(Configuration, Path, Option...) instead.

Create the named map for keys of the named class.

Parameters:

conf - configuration.

fs - filesystem.

dirName - dirName.

keyClass - keyClass.

valClass - valClass.

Throws:

IOException - raised on errors performing I/O.

Writer

@Deprecated
public Writer(Configuration conf,
                          FileSystem fs,
                          String dirName,
                          Class<? extends WritableComparable> keyClass,
                          Class valClass,
                          SequenceFile.CompressionType compress,
                          Progressable progress)
                   throws IOException

Deprecated. Use Writer(Configuration, Path, Option...) instead.

Create the named map for keys of the named class.

Parameters:

conf - configuration.

fs - fs.

dirName - dirName.

keyClass - keyClass.

valClass - valClass.

compress - compress.

progress - progress.

Throws:

IOException - raised on errors performing I/O.

Writer

@Deprecated
public Writer(Configuration conf,
                          FileSystem fs,
                          String dirName,
                          Class<? extends WritableComparable> keyClass,
                          Class valClass,
                          SequenceFile.CompressionType compress,
                          CompressionCodec codec,
                          Progressable progress)
                   throws IOException

Deprecated. Use Writer(Configuration, Path, Option...) instead.

Create the named map for keys of the named class.

Parameters:

conf - configuration.

fs - FileSystem.

dirName - dirName.

keyClass - keyClass.

valClass - valClass.

compress - compress.

codec - codec.

progress - progress.

Throws:

IOException - raised on errors performing I/O.

Writer

@Deprecated
public Writer(Configuration conf,
                          FileSystem fs,
                          String dirName,
                          Class<? extends WritableComparable> keyClass,
                          Class valClass,
                          SequenceFile.CompressionType compress)
                   throws IOException

Deprecated. Use Writer(Configuration, Path, Option...) instead.

Create the named map for keys of the named class.

Parameters:

conf - configuration.

fs - fs.

dirName - dirName.

keyClass - keyClass.

valClass - valClass.

compress - compress.

Throws:

IOException - raised on errors performing I/O.

Writer

@Deprecated
public Writer(Configuration conf,
                          FileSystem fs,
                          String dirName,
                          WritableComparator comparator,
                          Class valClass)
                   throws IOException

Deprecated. Use Writer(Configuration, Path, Option...) instead.

Create the named map using the named key comparator.

Parameters:

conf - configuration.

fs - fs.

dirName - dirName.

comparator - comparator.

valClass - valClass.

Throws:

IOException - raised on errors performing I/O.

Writer

@Deprecated
public Writer(Configuration conf,
                          FileSystem fs,
                          String dirName,
                          WritableComparator comparator,
                          Class valClass,
                          SequenceFile.CompressionType compress)
                   throws IOException

Deprecated. Use Writer(Configuration, Path, Option...) instead.

Create the named map using the named key comparator.

Parameters:

conf - configuration.

fs - filesystem.

dirName - dirName.

comparator - comparator.

valClass - valClass.

compress - compress.

Throws:

IOException - raised on errors performing I/O.

Writer

@Deprecated
public Writer(Configuration conf,
                          FileSystem fs,
                          String dirName,
                          WritableComparator comparator,
                          Class valClass,
                          SequenceFile.CompressionType compress,
                          Progressable progress)
                   throws IOException

Deprecated. Use Writer(Configuration, Path, Option...)} instead.

Create the named map using the named key comparator.

Parameters:

conf - configuration.

fs - filesystem.

dirName - dirName.

comparator - comparator.

valClass - valClass.

compress - CompressionType.

progress - progress.

Throws:

IOException - raised on errors performing I/O.

Writer

@Deprecated
public Writer(Configuration conf,
                          FileSystem fs,
                          String dirName,
                          WritableComparator comparator,
                          Class valClass,
                          SequenceFile.CompressionType compress,
                          CompressionCodec codec,
                          Progressable progress)
                   throws IOException

Deprecated. Use Writer(Configuration, Path, Option...) instead.

Create the named map using the named key comparator.

Parameters:

conf - configuration.

fs - FileSystem.

dirName - dirName.

comparator - comparator.

valClass - valClass.

compress - CompressionType.

codec - codec.

progress - progress.

Throws:

IOException - raised on errors performing I/O.

Writer

public Writer(Configuration conf,
              Path dirName,
              SequenceFile.Writer.Option... opts)
       throws IOException

Throws:

IOException

Method Detail

keyClass

public static MapFile.Writer.Option keyClass(Class<? extends WritableComparable> value)

comparator

public static MapFile.Writer.Option comparator(WritableComparator value)

valueClass

public static SequenceFile.Writer.Option valueClass(Class<?> value)

compression

public static SequenceFile.Writer.Option compression(SequenceFile.CompressionType type)

compression

public static SequenceFile.Writer.Option compression(SequenceFile.CompressionType type,
                                                     CompressionCodec codec)

progressable

public static SequenceFile.Writer.Option progressable(Progressable value)

getIndexInterval

public int getIndexInterval()

The number of entries that are added before an index entry is added.

Returns:

indexInterval

setIndexInterval

public void setIndexInterval(int interval)

Sets the index interval.

Parameters:

interval - interval.

See Also:

getIndexInterval()

setIndexInterval

public static void setIndexInterval(Configuration conf,
                                    int interval)

Sets the index interval and stores it in conf.

Parameters:

conf - configuration.

interval - interval.

See Also:

getIndexInterval()

close

public void close()
           throws IOException

Close the map.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

append

public void append(WritableComparable key,
                   Writable val)
            throws IOException

Append a key/value pair to the map. The key must be greater or equal to the previous key added to the map.

Parameters:

key - key.

val - value.

Throws:

IOException - raised on errors performing I/O.