cool.pandora.modeller.bag.impl

Class DefaultBag

java.lang.Object

cool.pandora.modeller.bag.impl.DefaultBag

public class DefaultBag
extends java.lang.Object

DefaultBag

Field Summary

Fields

Modifier and Type	Field and Description
static long	GB
static java.lang.String	GZ_LABEL
static long	KB
protected static org.slf4j.Logger	log
static long	MAX_SIZE
static long	MB
static java.lang.String	NO_LABEL
static short	NO_MODE
static java.lang.String	ZIP_LABEL
static short	ZIP_MODE

Constructor Summary

Constructors

Constructor and Description
DefaultBag()
DefaultBag(java.io.File rootDir, java.lang.String version)

Method Summary

Modifier and Type	Method and Description
void	addField(BagInfoField field)
void	addFileToPayload(java.io.File file)
void	addTagFile(java.io.File f)
void	clear()
java.lang.String	completeBag(gov.loc.repository.bagit.verify.impl.CompleteVerifierImpl completeVerifier)
void	createPreBag(java.io.File data)
void	createPreBagAddKeepFilesToEmptyFolders(java.io.File data) Makes BIL API call to create Bag in place and adding .keep files in empty Pay load folders
java.io.File	getBagFile()
java.lang.String	getBagInfoContent()
java.lang.String	getDataContent()
java.lang.String	getDataDirectory()
int	getDataNumber()
long	getDataSize()
BaggerFetch	getFetch()
java.util.List<java.lang.String>	getFetchPayload()
gov.loc.repository.bagit.FetchTxt	getFetchTxt()
java.lang.String	gethOCRResource()
DefaultBagInfo	getInfo()
java.lang.String	getListServiceBaseURI()
java.lang.String	getName()
java.util.Collection<gov.loc.repository.bagit.BagFile>	getPayload()
java.lang.String	getPayloadManifestAlgorithm()
java.util.List<java.lang.String>	getPayloadPaths()
cool.pandora.modeller.Profile	getProfile()
java.io.File	getRootDir()
java.lang.String	getSequenceID()
short	getSerialMode()
long	getSize()
java.lang.String	getTagManifestAlgorithm()
java.util.Collection<gov.loc.repository.bagit.BagFile>	getTags()
java.lang.String	getVersion()
boolean	hasText()
void	hasText(boolean b)
boolean	isAddKeepFilesToEmptyFolders() Getter Method for the value return value associated with the "Add .keep Files To Empty Folder" Check Box
void	isAddKeepFilesToEmptyFolders(boolean b) Setter Method for the passed value associated with the ".keep Files in Empty Folder(s):" Check Box
boolean	isBuildPayloadManifest()
void	isBuildPayloadManifest(boolean b)
boolean	isBuildTagManifest()
void	isBuildTagManifest(boolean b)
boolean	isHoley()
void	isHoley(boolean b)
boolean	isSerial()
void	isSerial(boolean b)
boolean	isSerialized()
boolean	isValidateOnSave()
void	isValidateOnSave(boolean b)
void	removeBagFile(java.lang.String fileName)
void	removeBagInfoField(java.lang.String key)
void	removePayloadDirectory(java.lang.String fileName)
void	setFetch(BaggerFetch fetch)
void	sethOCRResource(java.lang.String hOCRResource)
void	setListServiceBaseURI(java.lang.String listServiceURI)
void	setName(java.lang.String name)
void	setPayloadManifestAlgorithm(java.lang.String s)
void	setProfile(cool.pandora.modeller.Profile profile, boolean newBag)
void	setRootDir(java.io.File rootDir) This directory contains either the bag directory or serialized bag file
void	setSequenceID(java.lang.String sequenceID)
void	setSerialMode(short m)
void	setSize(long size)
void	setTagManifestAlgorithm(java.lang.String s)
void	setVersion(java.lang.String v)
void	updateBagInfo(java.util.Map<java.lang.String,java.lang.String> map)
void	updateStrategy()
java.lang.String	validateBag(gov.loc.repository.bagit.verify.impl.ValidVerifierImpl validVerifier)
java.lang.String	validateMetadata()
java.lang.String	write(gov.loc.repository.bagit.writer.Writer bw)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

KB

public static final long KB

See Also:

Constant Field Values

MB

public static final long MB

See Also:

Constant Field Values

GB

public static final long GB

See Also:

Constant Field Values

MAX_SIZE

public static final long MAX_SIZE

See Also:

Constant Field Values

NO_MODE

public static final short NO_MODE

See Also:

Constant Field Values

ZIP_MODE

public static final short ZIP_MODE

See Also:

Constant Field Values

NO_LABEL

public static final java.lang.String NO_LABEL

See Also:

Constant Field Values

ZIP_LABEL

public static final java.lang.String ZIP_LABEL

See Also:

Constant Field Values

GZ_LABEL

public static final java.lang.String GZ_LABEL

See Also:

Constant Field Values

Constructor Detail

DefaultBag

public DefaultBag()

DefaultBag

public DefaultBag(java.io.File rootDir,
                  java.lang.String version)

Parameters:

rootDir - File

version - String

Method Detail

createPreBag

public void createPreBag(java.io.File data)

Parameters:

data - File

createPreBagAddKeepFilesToEmptyFolders

public void createPreBagAddKeepFilesToEmptyFolders(java.io.File data)

Makes BIL API call to create Bag in place and adding .keep files in empty Pay load folders

getBagFile

public java.io.File getBagFile()

Returns:

bagFile

getDataDirectory

public java.lang.String getDataDirectory()

Returns:

dataDirectory

setVersion

public void setVersion(java.lang.String v)

Parameters:

v - String

getVersion

public java.lang.String getVersion()

Returns:

versionString

setName

public void setName(java.lang.String name)

Parameters:

name - String

getName

public java.lang.String getName()

Returns:

name

hasText

public void hasText(boolean b)

Parameters:

b - boolean

hasText

public boolean hasText()

Returns:

hasText

setSequenceID

public void setSequenceID(java.lang.String sequenceID)

Parameters:

sequenceID - String

getSequenceID

public java.lang.String getSequenceID()

Returns:

sequenceID

sethOCRResource

public void sethOCRResource(java.lang.String hOCRResource)

Parameters:

hOCRResource - String

gethOCRResource

public java.lang.String gethOCRResource()

Returns:

hOCRResource

setListServiceBaseURI

public void setListServiceBaseURI(java.lang.String listServiceURI)

Parameters:

listServiceURI - String

getListServiceBaseURI

public java.lang.String getListServiceBaseURI()

Returns:

listServiceURI

setSize

public void setSize(long size)

Parameters:

size - long

getSize

public long getSize()

Returns:

size

setRootDir

public void setRootDir(java.io.File rootDir)

This directory contains either the bag directory or serialized bag file

Parameters:

rootDir - File

getRootDir

public java.io.File getRootDir()

Returns:

rootDir

isHoley

public void isHoley(boolean b)

Parameters:

b - boolean

isHoley

public boolean isHoley()

Returns:

isHoley

isSerial

public void isSerial(boolean b)

Parameters:

b - boolean

isSerial

public boolean isSerial()

Returns:

isSerial

setSerialMode

public void setSerialMode(short m)

Parameters:

m - short

getSerialMode

public short getSerialMode()

Returns:

serialMode

isBuildTagManifest

public void isBuildTagManifest(boolean b)

Parameters:

b - boolean

isBuildTagManifest

public boolean isBuildTagManifest()

Returns:

isBuildTagManifest

isBuildPayloadManifest

public void isBuildPayloadManifest(boolean b)

Parameters:

b - boolean

isBuildPayloadManifest

public boolean isBuildPayloadManifest()

Returns:

isBuildPayloadManifest

setTagManifestAlgorithm

public void setTagManifestAlgorithm(java.lang.String s)

Parameters:

s - String

getTagManifestAlgorithm

public java.lang.String getTagManifestAlgorithm()

Returns:

tagManifestAlgorithm

setPayloadManifestAlgorithm

public void setPayloadManifestAlgorithm(java.lang.String s)

Parameters:

s - String

getPayloadManifestAlgorithm

public java.lang.String getPayloadManifestAlgorithm()

Returns:

payloadManifestAlgorithm

isAddKeepFilesToEmptyFolders

public void isAddKeepFilesToEmptyFolders(boolean b)

Setter Method for the passed value associated with the ".keep Files in Empty Folder(s):" Check Box

Parameters:

b - boolean

isAddKeepFilesToEmptyFolders

public boolean isAddKeepFilesToEmptyFolders()

Getter Method for the value return value associated with the "Add .keep Files To Empty Folder" Check Box

isValidateOnSave

public void isValidateOnSave(boolean b)

Parameters:

b - boolean

isValidateOnSave

public boolean isValidateOnSave()

Returns:

isValidateOnSave

isSerialized

public boolean isSerialized()

Returns:

isSerialized

updateBagInfo

public void updateBagInfo(java.util.Map<java.lang.String,java.lang.String> map)

Parameters:

map - Map

getInfo

public DefaultBagInfo getInfo()

Returns:

bagInfo

getBagInfoContent

public java.lang.String getBagInfoContent()

Returns:

bicontent

setFetch

public void setFetch(BaggerFetch fetch)

Parameters:

fetch - BaggerFetch

getFetch

public BaggerFetch getFetch()

Returns:

fetch

getFetchPayload

public java.util.List<java.lang.String> getFetchPayload()

Returns:

list

getDataContent

public java.lang.String getDataContent()

Returns:

dataContent

getDataSize

public long getDataSize()

Returns:

totalSize

getDataNumber

public int getDataNumber()

Returns:

size

setProfile

public void setProfile(cool.pandora.modeller.Profile profile,
                       boolean newBag)

Parameters:

profile - Profile

newBag - boolean

getProfile

public cool.pandora.modeller.Profile getProfile()

Returns:

profile

getPayloadPaths

public java.util.List<java.lang.String> getPayloadPaths()

Returns:

pathList

addTagFile

public void addTagFile(java.io.File f)

Parameters:

f - File

write

public java.lang.String write(gov.loc.repository.bagit.writer.Writer bw)

Parameters:

bw - Writer

Returns:

messages

completeBag

public java.lang.String completeBag(gov.loc.repository.bagit.verify.impl.CompleteVerifierImpl completeVerifier)

Parameters:

completeVerifier - CompleteVerifierImpl

Returns:

messages

validateMetadata

public java.lang.String validateMetadata()

Returns:

messages

validateBag

public java.lang.String validateBag(gov.loc.repository.bagit.verify.impl.ValidVerifierImpl validVerifier)

Parameters:

validVerifier - ValidVerifierImpl

Returns:

messages

updateStrategy

public void updateStrategy()

clear

public void clear()

addField

public void addField(BagInfoField field)

Parameters:

field - BagInfoField

removeBagInfoField

public void removeBagInfoField(java.lang.String key)

Parameters:

key - String

addFileToPayload

public void addFileToPayload(java.io.File file)

Parameters:

file - File

getTags

public java.util.Collection<gov.loc.repository.bagit.BagFile> getTags()

Returns:

tags

removeBagFile

public void removeBagFile(java.lang.String fileName)

Parameters:

fileName - String

removePayloadDirectory

public void removePayloadDirectory(java.lang.String fileName)

Parameters:

fileName - String

getPayload

public java.util.Collection<gov.loc.repository.bagit.BagFile> getPayload()

Returns:

payload

getFetchTxt

public gov.loc.repository.bagit.FetchTxt getFetchTxt()

Returns:

fetchtext