votorola.a

Class OutputStore

java.lang.Object

OutputStore

@ThreadSafe
public final class OutputStore
extends Object

Output store utilities. The output store contains service output, such as periodic snapshots of voter input, trust network traces and poll results. It includes both file data and relational data.

See Also:

VoteServer.outDirectory()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutputStore.ReadyDirectory The path to a snap/readyTrace, snap/readyCount or other output record.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	S_PATTERN The pattern of the filename suffix "-S"; where S is a serial number encoded in radix 36.
static FileFilter	SNAP_DIRECTORY_FILTER A file filter that accepts only directories that are named in the pattern of snapshot directories.
static String	SNAP_SUMMARY_FILENAME The name of the summary file in a snapshot directory.
static char	SUFFIX_DELIMITER The delimiter that marks the beginning of every filename suffix.
static Pattern	Y4MDS_PATTERN The pattern of the filename suffix "-YYYY-MD-S", where YYYY-MD encodes the nominal date and S is a serial number.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isS(String string) Answers whether the specified string matches S_PATTERN.
static boolean	isY4MDS(String string) Answers whether the specified string matches Y4MDS_PATTERN.
static File	mkdirsS(File parentDirectory, String baseName) Creates a unique directory named baseName-S, where -S is in the form of S_PATTERN.
static File	mkdirsY4MDS(File parentDirectory, String baseName) Creates a unique directory named baseName-YYYY-MD-S, where -YYYY-MD-S is in the form of Y4MDS_PATTERN.
static XMLStreamReader	newXMLStreamReader(Reader reader) Constructs a stream reader configured to read the snapshot summary file, and such.
static Calendar	setNominalDate(Calendar calendar, File snapDirectory) Clears the calendar and sets the date specified by the name pattern of the snap directory.
static String	suffix(String fileName) Returns the suffix of the specified file name, including the preceding delimiter.

Methods inherited from class java.lang.Object

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

Field Detail

S_PATTERN

public static final Pattern S_PATTERN

The pattern of the filename suffix "-S"; where S is a serial number encoded in radix 36.

See Also:

isS(String), mkdirsS(File,String)

SNAP_DIRECTORY_FILTER

public static final FileFilter SNAP_DIRECTORY_FILTER

A file filter that accepts only directories that are named in the pattern of snapshot directories.

See Also:

vocount, votrace

SNAP_SUMMARY_FILENAME

public static final String SNAP_SUMMARY_FILENAME

The name of the summary file in a snapshot directory.

See Also:

Constant Field Values

SUFFIX_DELIMITER

public static final char SUFFIX_DELIMITER

The delimiter that marks the beginning of every filename suffix.

See Also:

suffix(String), Y4MDS_PATTERN, Constant Field Values

Y4MDS_PATTERN

public static final Pattern Y4MDS_PATTERN

The pattern of the filename suffix "-YYYY-MD-S", where YYYY-MD encodes the nominal date and S is a serial number. All numbers are encoded in radix 36, except YYYY, which is plain radix 10. The resulting match (if any) is split into groups YYYY (1), M (2), D (3) and S (4).

See Also:

isY4MDS(String), mkdirsY4MDS(File,String)

Method Detail

isS

public static boolean isS(String string)

Answers whether the specified string matches S_PATTERN.

Parameters:

string - the string, which may be empty, or null

See Also:

S_PATTERN

isY4MDS

public static boolean isY4MDS(String string)

Answers whether the specified string matches Y4MDS_PATTERN.

Parameters:

string - the string, which may be empty, or null

See Also:

Y4MDS_PATTERN

mkdirsS

public static File mkdirsS(File parentDirectory,
           String baseName)
                    throws IOException

Creates a unique directory named baseName-S, where -S is in the form of S_PATTERN. Also creates super-directories, as necessary.

Throws:

IOException

See Also:

S_PATTERN

mkdirsY4MDS

public static File mkdirsY4MDS(File parentDirectory,
               String baseName)
                        throws IOException

Creates a unique directory named baseName-YYYY-MD-S, where -YYYY-MD-S is in the form of Y4MDS_PATTERN. Also creates super-directories, as necessary.

Throws:

IOException

See Also:

Y4MDS_PATTERN

newXMLStreamReader

public static XMLStreamReader newXMLStreamReader(Reader reader)
                                          throws XMLStreamException

Constructs a stream reader configured to read the snapshot summary file, and such.

Throws:

XMLStreamException

See Also:

SNAP_SUMMARY_FILENAME

setNominalDate

public static Calendar setNominalDate(Calendar calendar,
                      File snapDirectory)

Clears the calendar and sets the date specified by the name pattern of the snap directory.

Returns:

the same calendar.

suffix

public static String suffix(String fileName)

Returns the suffix of the specified file name, including the preceding delimiter. It is not guaranteed to be in any particular format.

Parameters:

fileName - without parent path

Returns:

the suffix, or null if there is none

See Also:

SUFFIX_DELIMITER