dk.netarkivet.common.utils.cdx
Class CDXUtils

java.lang.Object
  dk.netarkivet.common.utils.cdx.CDXUtils

public class CDXUtils
extends java.lang.Object

Utility class for creating CDX-files. The CDX-format is described here: http://www.archive.org/web/researcher/cdx_file_format.php

Constructor Summary

CDXUtils()

Method Summary

static void	generateCDX(java.io.File arcFileDirectory, java.io.File cdxFileDirectory) Applies createCDXRecord() to all ARC files in a directory, creating one CDX file per ARC file.
static void	writeCDXInfo(java.io.File arcfile, java.io.OutputStream cdxstream) Add cdx info for a given ARC file to a given OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

CDXUtils

public CDXUtils()

Method Detail

writeCDXInfo

public static void writeCDXInfo(java.io.File arcfile,
                                java.io.OutputStream cdxstream)

Add cdx info for a given ARC file to a given OutputStream. Note, any exceptions are logged on level FINE but otherwise ignored.

Parameters:

arcfile - A file with arc records

cdxstream - An output stream to add CDX lines to

generateCDX

public static void generateCDX(java.io.File arcFileDirectory,
                               java.io.File cdxFileDirectory)
                        throws ArgumentNotValid

Applies createCDXRecord() to all ARC files in a directory, creating one CDX file per ARC file. Note, any exceptions during index generation are logged at level FINE but otherwise ignored. Exceptions creating any cdx file are logged at level WARNING but otherwise ignored. CDX files are named as the arc files except ".arc" or ".arc.gz" is replaced with ".cdx"

Parameters:

arcFileDirectory - A directory with arcfiles to generate index for

cdxFileDirectory - A directory to generate CDX files in

Throws:

ArgumentNotValid - if any of directories are null or is not an existing directory, or if cdxFileDirectory is not writable.