org.marc4j.marc.DataField Maven / Gradle / Ivy
Show all versions of marc4j Show documentation
/**
* Copyright (C) 2004 Bas Peters
*
* This file is part of MARC4J
*
* MARC4J is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* MARC4J is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with MARC4J; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.marc4j.marc;
import java.util.List;
/**
* Represents a data field in a MARC record.
*
* Subfield Selectors
*
* The {@code getSubfields*} methods take a subfield selector string, or subfield spec.
*
* The subfield spec can either specify each subfield needed, thusly:
*
* -
* {@code abcfghnp}
*
*
* or the subfield spec can be enclosed in square brackets, and it
* will be treated as a regular expression character class
* and all subfields matching the pattern will be returned, thusly:
*
* -
* {@code [a-cf-hnp]}
*
*
* Since it uses {@code java.util.regex.Pattern} other valid forms will work:
*
* -
* {@code [^h]} returns all subfields except those with code 'h'
*
-
* {@code [a-z&&[^bc]]} returns any (lowercase) alphabetic subfield, except for 'b' or 'c'.
*
*
* Note for both forms described above the order of the subfields in the specification
* is irrelevant, all subfields that match will be returned in the order that they
* occur in the DataField.
*
* Note also that if an invalid regular expression character class (such as {@literal [c-a]} )
* is given to a subfield selector, it will throw a {@code java.util.regex.PatternSyntaxException}
* at runtime.
*
* @author Bas Peters
*/
public interface DataField extends VariableField {
/**
* Returns the first indicator of the DataField
*
* @return The first indicator of the DataField
*/
public char getIndicator1();
/**
* Sets the first indicator of the DataField.
*
* @param ind1 The first indicator of the DataField
*/
public void setIndicator1(char ind1);
/**
* Returns the second indicator of the DataField.
*
* @return The second indicator character of the DataField
*/
public char getIndicator2();
/**
* Sets the second indicator of the DataField.
*
* @param ind2 The second indicator of the DataField
*/
public void setIndicator2(char ind2);
/**
* Returns the {@link List} of {@link Subfield}.
*
* @return The {@link List} of {@link Subfield}s
*/
public List getSubfields();
/**
* Returns the {@link List} of {@link Subfield}s for the given subfield code.
*
* @param code The code of the subfields to return
* @return The {@link List} of {@link Subfield}s in the DataField
*/
public List getSubfields(char code);
/**
* Returns the list of Subfield objects that match the
* subfield spec. Subfields are returned in the order they occur in the DataField.
*
* Note that if an invalid subfield spec is given this this routine will quietly
* fail, and return no subfields whatsoever rather than throwing an exception.
*
* @param sfSpec - A subfield code pattern
* @return List - the list of Subfield objects
*/
public List getSubfields(String sfSpec);
/**
* Get the data from the specified subfields and returns a concatenated string.
* Subfields data are written to the string in the order the occur in the DataField.
*
* Note that if an invalid subfield spec is given this this routine will quietly
* fail, and return no subfields whatsoever rather than throwing an exception.
*
* @param sfSpec A subfield pattern which can include multiple subfield codes (e.g., "abc")
* @return requested subfield data, concatenated together as a single string,
* or null if no subfields are matched
* @throws java.util.regex.PatternSyntaxException if {@code sfSpec} is an invalid bracket expression.
*/
public String getSubfieldsAsString(String sfSpec);
/**
* Returns the first Subfield with the given code.
*
* @param code The subfield code of the Subfield to return
* @return The Subfield or null if no subfield is found
*/
public Subfield getSubfield(char code);
/**
* Adds the supplied Subfield to the DataField.
*
* @param subfield The Subfield object
* @throws IllegalAddException when the parameter is not a Subfield instance
*/
public void addSubfield(Subfield subfield);
/**
* Inserts a Subfield at the specified position.
*
* @param index The position at which to add the Subfield
* @param subfield The Subfield to add to the DataField
* @throws IllegalAddException when the parameter is not a Subfield instance
*/
public void addSubfield(int index, Subfield subfield);
/**
* Removes a Subfield.
*
* @param subfield The Subfield to remove
*/
public void removeSubfield(Subfield subfield);
}