/** * 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.io.Serializable; import java.util.List; import org.marc4j.MarcError; /** * Represents a MARC record. * * @author Bas Peters */ public interface Record extends Serializable { /** * Sets the identifier. The purpose of this identifier is to provide an * identifier for persistency. * * @param id the identifier */ public void setId(Long id); /** * Returns the identifier. * * @return Long - the identifier */ public Long getId(); /** * Sets the type of record. * * @param type the type of record */ public void setType(String type); /** * Returns the type of record. * * @return String - the type of record */ public String getType(); /** * Adds a VariableField. * * @param field the VariableField * @throws IllegalAddException when the parameter is not a VariableField * instance */ public void addVariableField(VariableField field); /** * Removes a variable field from the collection. * * @param field the variable field */ public void removeVariableField(VariableField field); /** * Returns a list of variable fields * * @return List - the variable fields */ public List getVariableFields(); /** * Gets a {@link List} of {@link VariableField}s from the {@link Record} * including the LEADER recast as ControlField for field matching purposes. * * @return a List of all VariableFields plus the Leader represented as a ControlField */ public List getVariableFieldsWithLeader(); /** * Returns a list of control fields * * @return List - the control fields */ public List getControlFields(); /** * Returns a list of data fields * * @return List - the data fields */ public List getDataFields(); /** * Returns the control number field or null if no control * number field is available. * * @return ControlField - the control number field */ public ControlField getControlNumberField(); /** * Returns the control number or null if no control number is * available. * * This method returns the data for a ControlField with tag * 001. * * @return String - the control number */ public String getControlNumber(); /** * Returns the first instance of the variable field with the given tag. * * @param tag - the tag of the field to return * @return the first field that matches the supplied tag */ public VariableField getVariableField(String tag); /** * Returns a list of variable fields with the given tag. * * @param tag - the tag of the field to return * @return a list of fields that matches the supplied tag */ public List getVariableFields(String tag); /** * Returns a list of variable fields for the given tags. *

* For example: * * 

     * String tags = { "100", "245", "260", "300" };
     *
     * List fields = record.getVariableFields(tags);
     *
* @param tags - an array of tags any fields that match will be returned * @return a list of fields that matches one of the supplied tags */ public List getVariableFields(String[] tags); /** * Returns the Leader. * * @return Leader - the Leader */ public Leader getLeader(); /** * Sets the Leader. * * @param leader the Leader */ public void setLeader(Leader leader); /** * Returns a List of VariableField objects that have a data element that * matches the given regular expression. *

* See {@link java.util.regex.Pattern} for more information about Java * regular expressions. *

* * @param pattern the regular expression * @return List - the result list */ public List find(String pattern); /** * Returns a List of VariableField objects with the given tag that have a * data element that matches the given regular expression. *

* See {@link java.util.regex.Pattern} for more information about Java * regular expressions. *

* * @param tag the tag value * @param pattern the regular expression * @return List - the result list */ public List find(String tag, String pattern); /** * Returns a List of VariableField objects with the given tags that have a * data element that matches the given regular expression. *

* See {@link java.util.regex.Pattern} for more information about Java * regular expressions. *

* * @param tag the tag values * @param pattern the regular expression * @return List - the result list */ public List find(String[] tag, String pattern); /** * Logs an error message using the stated severity level. Uses the values passed * in id, field, and subfield to note the location of the error. * * @param field - the tag of the field currently being processed * @param subfield - the subfield tag of the subfield currently being processed * @param severity - An indication of the relative severity of the error that was * encountered. * @param message - A descriptive message about the error that was encountered. */ public void addError(String field, String subfield, int severity, String message); /** * Copies a List of errors into the current error handler * * @param newErrors - A list of Errors. */ public void addErrors(List newErrors); /** * Returns true if any errors were found for this record * * @return true if any errors were found for this record */ public boolean hasErrors(); /** * Returns the errors found for this record * * @return List of all Errors that were found for this record */ public List getErrors(); }