Package nl.knaw.dans.bagit.domain

Class Metadata

java.lang.Object

nl.knaw.dans.bagit.domain.Metadata

public class Metadata
extends Object

A class to represent the bag-info.txt (and package-info.txt in older versions)

Field Summary

Fields

Modifier and Type	Field	Description
private List<AbstractMap.SimpleImmutableEntry<String,String>>	list
private Map<String,List<String>>	map
private static final String	PAYLOAD_OXUM

Constructor Summary

Constructors

Constructor	Description
Metadata()

Method Summary

Modifier and Type	Method	Description
boolean	add(String key, String value)	add a entry into the metadata or append a value if the label already exists
void	addAll(List<AbstractMap.SimpleImmutableEntry<String,String>> data)	add multiple metadata entries
boolean	contains(String key)	check if the metadata contains a particular label(key)
boolean	equals(Object obj)
List<String>	get(String key)	get all the values for a specific label (key)
List<AbstractMap.SimpleImmutableEntry<String,String>>	getAll()	all the metadata
protected List<AbstractMap.SimpleImmutableEntry<String,String>>	getList()
protected Map<String,List<String>>	getMap()
int	hashCode()
boolean	isEmpty()
void	remove(String key)	remove the label and all its values
protected void	setList(List<AbstractMap.SimpleImmutableEntry<String,String>> list)
protected void	setMap(Map<String,List<String>> map)
String	toString()
boolean	upsertPayloadOxum(String payloadOxumValue)	payload oxum is a special case where it makes no sense to have multiple values so instead of just appending we upsert (insert or update)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PAYLOAD_OXUM

private static final String PAYLOAD_OXUM

See Also:

• Constant Field Values

map

private Map<String,List<String>> map

list

private List<AbstractMap.SimpleImmutableEntry<String,String>> list

Constructor Details

Metadata

public Metadata()

Method Details

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAll

public List<AbstractMap.SimpleImmutableEntry<String,String>> getAll()

all the metadata

Returns:

return the order and case preserved metadata

get

public List<String> get(String key)

get all the values for a specific label (key)

Parameters:

key - the case insensitive label(key) in the metadata

Returns:

the list of values for that label

add

public boolean add(String key,
 String value)

add a entry into the metadata or append a value if the label already exists

Parameters:

key - the label

value - the value of the label

Returns:

true (as specified by Collection.add(E))

remove

public void remove(String key)

remove the label and all its values

Parameters:

key - the label to remove along with its value(s)

contains

public boolean contains(String key)

check if the metadata contains a particular label(key)

Parameters:

key - the label to check

Returns:

if the label exists

addAll

public void addAll(List<AbstractMap.SimpleImmutableEntry<String,String>> data)

add multiple metadata entries

Parameters:

data - the metadata to add

upsertPayloadOxum

public boolean upsertPayloadOxum(String payloadOxumValue)

payload oxum is a special case where it makes no sense to have multiple values so instead of just appending we upsert (insert or update)

Parameters:

payloadOxumValue - the value payload-oxum should be set to

Returns:

true (as specified by Collection.add(E))

isEmpty

public boolean isEmpty()

Returns:

true if this metadata contains no entries

getMap

protected Map<String,List<String>> getMap()

setMap

protected void setMap(Map<String,List<String>> map)

getList

protected List<AbstractMap.SimpleImmutableEntry<String,String>> getList()

setList

protected void setList(List<AbstractMap.SimpleImmutableEntry<String,String>> list)