org.jwat.warc

Class WarcFileNamingDefault

java.lang.Object

org.jwat.warc.WarcFileNamingDefault

All Implemented Interfaces:

WarcFileNaming

public class WarcFileNamingDefault
extends Object
implements WarcFileNaming

Default WARC file naming implementation used for writing to multiple files. (prefix-date-sequenceNr-hostname.extension)

Author:

nicl

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	date Date component.
protected DateFormat	dateFormat DateFormat to the following format 'yyyyMMddHHmmss'.
protected String	dateStr Date component converted into a human readable string.
protected String	extension Extension component (including leading ".").
protected String	filePrefix Prefix component.
protected String	hostname Host name component.

Constructor Summary

Constructors

Constructor and Description
WarcFileNamingDefault(String filePrefix, Date date, String hostname, String extension) Construct file naming instance.

Method Summary

Modifier and Type	Method and Description
String	getFilename(int sequenceNr, boolean bCompressed) Return the next file name to use.
boolean	supportMultipleFiles() Does this naming implementation support multiple files.

Methods inherited from class java.lang.Object

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

Field Detail

dateFormat

protected DateFormat dateFormat

DateFormat to the following format 'yyyyMMddHHmmss'.

filePrefix

protected String filePrefix

Prefix component.

date

protected Date date

Date component.

dateStr

protected String dateStr

Date component converted into a human readable string.

hostname

protected String hostname

Host name component.

extension

protected String extension

Extension component (including leading ".").

Constructor Detail

WarcFileNamingDefault

public WarcFileNamingDefault(String filePrefix,
                             Date date,
                             String hostname,
                             String extension)

Construct file naming instance.

Parameters:

filePrefix - prefix or null, will default to "JWAT"

date - date or null, if you want current date

hostname - host name or null, if you want to use default local host name

extension - extension or null, will default to ".warc"

Method Detail

supportMultipleFiles

public boolean supportMultipleFiles()

Description copied from interface: WarcFileNaming

Does this naming implementation support multiple files.

Specified by:

supportMultipleFiles in interface WarcFileNaming

Returns:

boolean indicating support for multiple files

getFilename

public String getFilename(int sequenceNr,
                          boolean bCompressed)

Description copied from interface: WarcFileNaming

Return the next file name to use.

Specified by:

getFilename in interface WarcFileNaming

Parameters:

sequenceNr - sequence number to use

bCompressed - is the file compressed or not

Returns:

the next file name to use