org.marc4j.marc

Interface DataField

All Superinterfaces:

Comparable<VariableField>, Serializable, VariableField

All Known Implementing Classes:

DataFieldImpl

public interface DataField
extends VariableField

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.

Author:

Bas Peters, Kevin S. Clarke

Method Summary

Methods

Modifier and Type	Method and Description
void	addSubfield(int aIndex, Subfield aSubfield) Inserts a Subfield at the specified position.
void	addSubfield(Subfield aSubfield) Adds the supplied Subfield to the DataField.
int	countSubfields() Returns the number of subfields in this DataField.
char	getIndicator1() Returns the first indicator of the DataField
char	getIndicator2() Returns the second indicator of the DataField.
Subfield	getSubfield(char aCode) Returns the first Subfield with the given code.
List<Subfield>	getSubfields() Returns the List of Subfield.
List<Subfield>	getSubfields(char aCode) Returns the List of Subfields for the given subfield code.
void	removeSubfield(Subfield aSubfield) Removes a Subfield.
void	setIndicator1(char aFirstInd) Sets the first indicator of the DataField.
void	setIndicator2(char aSecondInd) Sets the second indicator of the DataField.

Methods inherited from interface org.marc4j.marc.VariableField

find, getId, getTag, setId, setTag

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getIndicator1

char getIndicator1()

Returns the first indicator of the DataField

Returns:

The first indicator of the DataField

setIndicator1

void setIndicator1(char aFirstInd)

Sets the first indicator of the DataField.

Parameters:

aFirstInd - The first indicator of the DataField

getIndicator2

char getIndicator2()

Returns the second indicator of the DataField.

Returns:

The second indicator character of the DataField

setIndicator2

void setIndicator2(char aSecondInd)

Sets the second indicator of the DataField.

Parameters:

aSecondInd - The second indicator of the DataField

getSubfields

List<Subfield> getSubfields()

Returns the List of Subfield.

Returns:

The List of Subfields

getSubfields

List<Subfield> getSubfields(char aCode)

Returns the List of Subfields for the given subfield code.

Parameters:

aCode - The code of the subfields to return

Returns:

The List of Subfields in the DataField

getSubfield

Subfield getSubfield(char aCode)

Returns the first Subfield with the given code.

Parameters:

aCode - The subfield code of the Subfield to return

Returns:

The Subfield or null if no subfield is found

addSubfield

void addSubfield(Subfield aSubfield)

Adds the supplied Subfield to the DataField.

Parameters:

aSubfield - The Subfield object

Throws:

IllegalAddException - when the parameter is not a Subfield instance

addSubfield

void addSubfield(int aIndex,
               Subfield aSubfield)

Inserts a Subfield at the specified position.

Parameters:

aIndex - The position at which to add the Subfield

aSubfield - The Subfield to add to the DataField

Throws:

IllegalAddException - when the supplied Subfield is of the wrong type

removeSubfield

void removeSubfield(Subfield aSubfield)

Removes a Subfield.

Parameters:

aSubfield - The Subfield to remove

countSubfields

int countSubfields()

Returns the number of subfields in this DataField.

Returns:

The number of subfields in this DataField