edu.isi.nlp.files.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-core-open Show documentation

The newest version!

/**
 * Various utilities for working with file I/O.
 *
 * The major bits of code here are:
 *
 * 

 *   {@link edu.isi.nlp.files.FileUtils}: various utility methods for working with files.
 *   {@link edu.isi.nlp.files.KeyValueSource}, {@link edu.isi.nlp.files.KeyValueSink} and
 *       related classes: an implementation-agnostic way of working with mappings between keys
 *       and values. In practice we largely use these for mapping between document IDs and documents
 *       without worrying about whether the storage is a filesystem, database, or something else.
 *       These should be instantiated via {@link edu.isi.nlp.files.KeyValueSources} and {@link
 *       edu.isi.nlp.files.KeyValueSinks}
 * 
 *
 * The are some additional minor utilities:
 *
 * 
 *   Tool to split a document corpus: {@link edu.isi.nlp.files.SplitCorpus}
 *   
Class to load three column tab-separated files as a {@link
 *       edu.isi.nlp.collections.Multitable}: {@link edu.isi.nlp.files.MultitableLoader}
 *   
Working with document lists: {@link edu.isi.nlp.files.MergeFileLists}, {@link
 *       edu.isi.nlp.files.SubtractFileLists}
 *   
Working with document Id to file maps: {@link
 *       edu.isi.nlp.files.DocIDToFileMapContains}, {@link edu.isi.nlp.files.SubtractFileMaps}
 * 
 */
@ParametersAreNonnullByDefault
package edu.isi.nlp.files;

import javax.annotation.ParametersAreNonnullByDefault;