Package org.cdlib.xtf.util

The 'util' package contains a number of general utility classes used by other code throughout XTF.

See:
          Description

Interface Summary
Linkable All entries added to an EmbeddedList must implement this interface.
Normalizer.PlatformNormalizer Generic interface for normalizers
StructuredStore A simple structured storage with a flat top-level directory.
 

Class Summary
ArrayUtil Various handy functions for working with arrays.
Attrib A simple key/value relationship.
AttribList Maintains a list of key/value pairs.
Base64 Utility class that decodes Base64 data.
CharMap Maintains an in-memory, one-to-one mapping from characters in one set to characters in another.
CheckingTokenStream Used for debugging optimized FastTokenStream, this class checks the main TokenStream against a reference one for equality.
CircularQueue A simple queue of fixed size, that provides very fast insertion, deletion, and scanning.
ConsecutiveMap Implements a simple mapping, from object keys to integers.
DirSync Routines to synchronize one directory hierarchy to match another.
DiskHashReader Provides quick access to a disk-based hash table created by a DiskHashWriter.
DiskHashWriter Creates a persistent string to byte buffer hash table on disk, optimized for quick access.
DocTypeDeclRemover The parser that comes with the JDK always tries to resolve DOCTYPE declarations in an XML file, but will barf if it can't.
EasyNode Provides an easy-to-use wrapper around a Saxon NodeInfo.
EmbeddedList This class implements a linked list, where the links are embedded within the objects added to the list.
FastCache<K,V> A fast but inflexible cache where the keys are anything, the size is fixed, and a crude LRU policy is enforced.
FastHashMap<K,V> A fast but inflexible hash table where the keys are strings and the size is fixed.
FastHashMap.Ent<K,V> Keeps track of a single entry in the hash table.
FastIntCache A fast but inflexible cache where the keys are integers, the size is fixed, and a crude LRU policy is enforced.
FastStringReader Used to bypass the slowness of a Lucene StringReader (but only when used in conjuction with a FastTokenizer).
FastTokenizer Like Lucene's StandardTokenizer, but handles the easy cases very quickly.
FileWalker The FileWalker class is a utility class that simplifies traversing all the files in a file-system directory, and optionally, in any sub-directories.
FloatList A fast, array-based, expandable list of floats.
IntHash A fast but inflexible hash table where the keys are integers and the size is fixed.
IntMultiMap This class efficiently implements a "one to many" relationship between integer keys and multiple integer values.
LimitedOutputStream This class is useful only for testing the transmission speed of data by limiting the size of the output stream.
LineReader Provides a line-based interface for reading a file.
LinkableImpl A simple implementation of the Linkable interface.
Normalizer Handles Unicode normalization, dynamically choosing whichever of the built-in Java classes is available to do the work (these changed between Java 1.5 and Java 1.6).
Normalizer.Jdk15Normalizer Normalizer that runs on JDK 1.5 / 5.0
Normalizer.Jdk16Normalizer Normalizer that runs on JDK 1.6 / 6.0 and higher
PackedByteBuf Packs ints and strings into a byte buffer, using an efficient variable-size int format.
Path The Path class provides a number of utilities that makes working with file system paths easier.
ProcessRunner Copyright (c) 2009, Regents of the University of California All rights reserved.
ProcessRunner.InputStuffer Class to stuff input into the process's input stream (an OutputStream to us).
ProcessRunner.Interrupter Used to interrupt the main thread if a timeout occurs
ProcessRunner.OutputGrabber Class to accumulate the output from a process's output stream (which is an InputStream to us), and turn it into a string.
StructuredFile A simple structured file with a flat top-level directory.
SubDirFilter This class provides an efficient means to determine if a given subdirectory is "in" or "out" of the set of directories specified to index.
SubFileReader Reads a single sub-file within a StructuredFile.
SubFileWriter Represents a single sub-file within a StructuredFile.
SubStoreReader Reads from a single sub-store within a StructuredStore.
SubStoreWriter Writes to a single sub-store within a StructuredStore.
TagArray This class implements a resizable container for Tags, which are short typed strings that are efficiently stored.
TagChars Class that represents a slice of a block, for quick access to byte-level strings without object allocation.
Tester Handles tedious details of making a little regression test for a given class.
ThreadWatcher Keeps an eye on threads, and logs those that appear to be "runaways".
ThreadWatcher.Entry Keeps track of one thread we're watching.
Trace The Trace class provides a mechanism for logging output messages to the console or any PrintStream or Writer.
TraceWriter This is a simple PrintStream derivative that sends its output to the XTF Trace class instead of stdout or stderr.
WordMap Maintains an in-memory, one-to-one mapping from words in one set to words in another.
XMLFormatter This class provides a simple way to produce indented XML with matched begin and end tags.
XMLWriter Simple utility class that takes a Node or Source (representing an XML document) and produces an indented string representation of it.
XTFSaxonErrorListener Replacement error listener that redirects Saxon error messages to the standard XTF Trace facility.
 

Exception Summary
GeneralException A general-purpose exception used for problems that may occasionally happen and are expected to.
ProcessRunner.CommandFailedException Exception thrown if an external command ends with a non-zero exit status.
 

Package org.cdlib.xtf.util Description

The 'util' package contains a number of general utility classes used by other code throughout XTF. They can be divided into the following categories:

  1. Data Structures / Iterators
  2. Encoding/Decoding
  3. Fast Tokenization
  4. Structured Disk Files
  5. XML-Related
  6. Input/Output and Files
  7. Other