Package org.marc4j.marc

Class Subfield

java.lang.Object

org.marc4j.marc.Subfield

All Implemented Interfaces:

Serializable, Cloneable

public class Subfield
extends Object
implements Serializable, Cloneable

Subfield defines behaviour for a subfield (a data element within a data field).

A subfield consists of a delimiter followed by a data element identifier (together the subfield code) and a data element. The structure of a data element according to the MARC standard is as follows:

 DELIMITER DATA_ELEMENT_IDENTIFIER DATA_ELEMENT
 

This structure is returned by the marshal() method.

Author:

Bas Peters

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	EMPTY_LINK_CODE	Empty value for the link code

Constructor Summary

Constructors

Constructor	Description
Subfield()	Default constructor
Subfield(char code, char[] data)	Creates a new Subfield instance and registers the data element identifier and the data element.
Subfield(char code, char[] data, String linkCode)	Creates a new Subfield instance and registers the data element identifier and the data element.
Subfield(char code, String data)	Creates a new Subfield instance and registers the data element identifier and the data element.
Subfield(char code, String data, String linkCode)	Creates a new Subfield instance and registers the data element identifier and the data element.
Subfield(Subfield other)	Copy constructor

Method Summary

Modifier and Type	Method	Description
Object	clone()	Deprecated.
boolean	equals(Object obj)
boolean	find(Pattern pattern)	Returns true is the supplied regular expression pattern matches the Subfield data; else, false.
char	getCode()	Gets the Subfield code.
char[]	getData()	Gets the Subfield data.
String	getLinkCode()	Gets the Subfield link code.
int	hashCode()
String	marshal()	Returns a String representation for a data element following the structure of a MARC data element.
void	setCode(char code)	Sets the Subfield code.
void	setData(char[] data)	Sets the Subfield data.
void	setData(String data)	Sets the Subfield data.
void	setLinkCode(String linkCode)	Sets the Subfield link code.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_LINK_CODE

public static final String EMPTY_LINK_CODE

Empty value for the link code

Constructor Detail

Subfield

public Subfield()

Default constructor

Subfield

public Subfield(char code,
                char[] data)

Creates a new Subfield instance and registers the data element identifier and the data element.

Parameters:

code - the data element identifier

data - the data element

Subfield

public Subfield(char code,
                String data)

Creates a new Subfield instance and registers the data element identifier and the data element.

Parameters:

code - the data element identifier

data - the data element

Subfield

public Subfield(char code,
                char[] data,
                String linkCode)

Creates a new Subfield instance and registers the data element identifier and the data element.

Parameters:

code - the data element identifier

data - the data element

linkCode - A code if the subfield has a link with another Record.

Subfield

public Subfield(char code,
                String data,
                String linkCode)

Creates a new Subfield instance and registers the data element identifier and the data element.

Parameters:

code - the data element identifier

data - the data element

linkCode - A code if the subfield has a link with another Record.

Subfield

public Subfield(Subfield other)

Copy constructor

Parameters:

other - Another instance of Subfield

Method Detail

find

public boolean find(Pattern pattern)

Returns true is the supplied regular expression pattern matches the Subfield data; else, false.

Parameters:

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

setCode

public void setCode(char code)

Sets the Subfield code.

Parameters:

code - The code identifier

getCode

public char getCode()

Gets the Subfield code.

Returns:

char The code identifier

setData

public void setData(char[] data)

Sets the Subfield data.

Parameters:

data - The data element

setData

public void setData(String data)

Sets the Subfield data.

Parameters:

data - The data element

getData

public char[] getData()

Gets the Subfield data.

Returns:

char[] The data element

setLinkCode

public void setLinkCode(String linkCode)

Sets the Subfield link code.

getLinkCode

public String getLinkCode()

Gets the Subfield link code.

marshal

public String marshal()

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

Returns:

String The marshaled representation of this Subfield

clone

@Deprecated
public Object clone()

Deprecated.

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object