Package org.marc4j.marc

Class DataField

java.lang.Object

org.marc4j.marc.VariableField

org.marc4j.marc.DataField

All Implemented Interfaces:

Serializable, Cloneable

public class DataField
extends VariableField
implements Serializable, Cloneable

DataField defines behavior for a data field (tag 010-999).

Data fields are variable fields identified by tags beginning with ASCII numeric values other than two zero's. Data fields contain indicators, subfield codes, data and a field terminator. The structure of a data field according to the MARC standard is as follows:

 INDICATOR_1  INDICATOR_2  DELIMITER  DATA_ELEMENT_IDENTIFIER_1  DATA_ELEMENT_1  ...  DELIMITER  DATA_ELEMENT_IDENTIFIER_n  DATA_ELEMENT_n  FT
 

This structure is returned by the marshal() method.

Author:

Bas Peters

See Also:

Serialized Form

Field Summary

Fields inherited from class org.marc4j.marc.VariableField

EMPTY_ID

Constructor Summary

Constructors

Constructor	Description
DataField()	Default constructor.
DataField(String tag)	Creates a new DataField instance and registers the tag name.
DataField(String tag, char ind1, char ind2)	Creates a new DataField and sets the tag name and the first and second indicator.
DataField(String tag, char ind1, char ind2, Long id)	Creates a new DataField and sets the tag name and the first and second indicator, and the id
DataField(DataField other)	Copy constructor Copy id attribute, so if you don't want has the same, use copy(DataField).

Method Summary

Modifier and Type	Method	Description
void	add(Subfield subfield)	Deprecated. Use {addSubfield(Subfield)
void	addSubfield(int index, Subfield subfield)	Adds a new Subfield instance at the specified position.
void	addSubfield(Subfield subfield)	Adds a new Subfield instance to the collection of data elements.
Object	clone()	Deprecated.
static DataField	copy(DataField original)	Creates a copy of the original instance without copy the id attribute.
boolean	equals(Object obj)
boolean	find(Pattern pattern)	Returns true if a match is found for the supplied regular expression pattern; else, false.
Optional<Subfield>	getFirstSubfield(char code)	Returns the first Subfield with the supplied char code.
char	getIndicator1()	Returns the first indicator.
char	getIndicator2()	Returns the second indicator.
int	getLength()	Returns the length of the serialized form of the current data field.
Subfield	getSubfield(char code)	Deprecated. Use getFirstSubfield(char)
List<Subfield>	getSubfieldList()	Deprecated. Use {getSubfields()
List<Subfield>	getSubfields()	Returns the collection of Subfields
Stream<Subfield>	getSubfields(char code)	Returns a Stream of Subfields with the supplied char code.
int	hashCode()
boolean	hasSubfield(char code)	Returns true if there is a subfield with the given identifier.
String	marshal()	Returns a String representation for a data field following the structure of a MARC data field.
void	removeSubfield(Subfield subfield)	Removes a Subfield from the field.
void	setIndicator1(char ind1)	Registers the first indicator value.
void	setIndicator2(char ind2)	Registers the second indicator value.
void	setSubfieldList(List<Subfield> subfields)	Deprecated. Use {setSubfields(List)
void	setSubfields(List<Subfield> subfields)	Sets the collection of data elements.
void	setTag(String tag)	Registers the tag.
String	toString()

Methods inherited from class org.marc4j.marc.VariableField

getId, getTag, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

DataField

public DataField()

Default constructor.

DataField

public DataField(String tag)

Creates a new DataField instance and registers the tag name.

Parameters:

tag - The tag name

DataField

public DataField(String tag,
                 char ind1,
                 char ind2)

Creates a new DataField and sets the tag name and the first and second indicator.

Parameters:

tag - The tag name

ind1 - The first indicator

ind2 - The second indicator

DataField

public DataField(String tag,
                 char ind1,
                 char ind2,
                 Long id)

Creates a new DataField and sets the tag name and the first and second indicator, and the id

Parameters:

tag - The tag name

ind1 - The first indicator

ind2 - The second indicator

id - The id for the DataField

DataField

public DataField(DataField other)

Copy constructor Copy id attribute, so if you don't want has the same, use copy(DataField).

Parameters:

other - Another instance of DataField, where to copy all the values

Method Detail

copy

public static DataField copy(DataField original)

Creates a copy of the original instance without copy the id attribute.

Parameters:

original - Instance to copy.

Returns:

new copy of original instance without the id attribute.

find

public boolean find(Pattern pattern)

Returns true if a match is found for the supplied regular expression pattern; else, false.

Specified by:

find in class VariableField

Parameters:

pattern - An instance of a compiled Pattern to use as matcher

add

@Deprecated
public void add(Subfield subfield)

Deprecated.

Use {addSubfield(Subfield)

Adds a new Subfield instance to the collection of data elements.

Parameters:

subfield - the data element

See Also:

Subfield

addSubfield

public void addSubfield(Subfield subfield)

Adds a new Subfield instance to the collection of data elements.

Parameters:

subfield - The Subfield of a DataField

See Also:

Subfield

addSubfield

public void addSubfield(int index,
                        Subfield subfield)

Adds a new Subfield instance at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters:

index - The subfield's position within the list

subfield - The Subfield of a DataField

removeSubfield

public void removeSubfield(Subfield subfield)

Removes a Subfield from the field.

Parameters:

subfield - The subfield to remove from the field.

getSubfield

@Deprecated
public Subfield getSubfield(char code)

Deprecated.

Use getFirstSubfield(char)

Returns the first Subfield with the supplied char code.

Parameters:

code - A Subfield code

Returns:

A Subfield instance or null

getFirstSubfield

public Optional<Subfield> getFirstSubfield(char code)

Returns the first Subfield with the supplied char code.

Parameters:

code - A Subfield code

Returns:

An Optional<Subfield> of the first subfield with the supplied char code

getSubfields

public Stream<Subfield> getSubfields(char code)

Returns a Stream of Subfields with the supplied char code.

Parameters:

code - A Subfield code

Returns:

A Stream of Subfield

hasSubfield

public boolean hasSubfield(char code)

Returns true if there is a subfield with the given identifier.

Parameters:

code - the data element identifier

Returns:

true if the data element exists, false if not

setTag

public void setTag(String tag)

Registers the tag.

Overrides:

setTag in class VariableField

Parameters:

tag - the tag name

Throws:

IllegalTagException - when the tag is not a valid data field identifier

setIndicator1

public void setIndicator1(char ind1)

Registers the first indicator value.

Parameters:

ind1 - the first indicator

Throws:

IllegalIndicatorException - when the indicator value is invalid

setIndicator2

public void setIndicator2(char ind2)

Registers the second indicator value.

Parameters:

ind2 - the second indicator

Throws:

IllegalIndicatorException - when the indicator value is invalid

getIndicator1

public char getIndicator1()

Returns the first indicator.

Returns:

char - the first indicator

getIndicator2

public char getIndicator2()

Returns the second indicator.

Returns:

char - the second indicator

getSubfieldList

@Deprecated
public List<Subfield> getSubfieldList()

Deprecated.

Use {getSubfields()

Returns the collection of data elements.

Returns:

List - the data element collection

See Also:

Subfield

getSubfields

public List<Subfield> getSubfields()

Returns the collection of Subfields

Returns:

List the Subfield element collection

See Also:

Subfield

setSubfieldList

@Deprecated
public void setSubfieldList(List<Subfield> subfields)

Deprecated.

Use {setSubfields(List)

Sets the collection of data elements.

A collection of data elements is a List object with null or more Subfield objects.

Note: this method replaces the current List of subfields with the subfields in the new List.

Parameters:

newList - the new data element collection

setSubfields

public void setSubfields(List<Subfield> subfields)

Sets the collection of data elements.

A collection of data elements is a List object with null or more Subfield objects.

Note: this method replaces the current List of subfields with the subfields in the new List.

Parameters:

newList - the new data element collection

marshal

public String marshal()

Returns a String representation for a data field following the structure of a MARC data field.

Returns:

String - the data field

getLength

public int getLength()

Returns the length of the serialized form of the current data field.

Returns:

int - the data field length

clone

@Deprecated
public Object clone()

Deprecated.

Specified by:

clone in class VariableField

equals

public boolean equals(Object obj)

Specified by:

equals in class VariableField

hashCode

public int hashCode()

Specified by:

hashCode in class VariableField

toString

public String toString()

Overrides:

toString in class Object