org.marc4j.marc.Leader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marc4j Show documentation
An easy to use Application Programming Interface (API) for working with MARC and MARCXML in Java.
There is a newer version: 2.9.5
/**
 * 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;

/**
 * Represents a record label in a MARC record.
 *
 * @author Bas Peters
 */
public interface Leader 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 logical record length (positions 00-04).
     *
     * @param recordLength integer representing the record length
     */
    public void setRecordLength(int recordLength);

    /**
     * Sets the record status (position 05).
     *
     * @param recordStatus character representing the record status
     */
    public void setRecordStatus(char recordStatus);

    /**
     * Sets the type of record (position 06).
     *
     * @param typeOfRecord character representing the type of record
     */
    public void setTypeOfRecord(char typeOfRecord);

    /**
     * Sets implementation defined values (position 07-08).
     *
     * @param implDefined1 character array representing the implementation
     *        defined data
     */
    public void setImplDefined1(char[] implDefined1);

    /**
     * Sets the character encoding scheme (position 09).
     *
     * @param charCodingScheme character representing the character encoding
     */
    public void setCharCodingScheme(char charCodingScheme);

    /**
     * Sets the indicator count (position 10).
     *
     * @param indicatorCount integer representing the number of indicators
     *        present in a data field
     */
    public void setIndicatorCount(int indicatorCount);

    /**
     * Sets the subfield code length (position 11).
     *
     * @param subfieldCodeLength integer representing the subfield code length
     */
    public void setSubfieldCodeLength(int subfieldCodeLength);

    /**
     * Sets the base address of data (positions 12-16).
     *
     * @param baseAddressOfData integer representing the base address of data
     */
    public void setBaseAddressOfData(int baseAddressOfData);

    /**
     * Sets implementation defined values (positions 17-19).
     *
     * @param implDefined2 character array representing the implementation
     *        defined data
     */
    public void setImplDefined2(char[] implDefined2);

    /**
     * Sets the entry map (positions 20-23).
     *
     * @param entryMap character array representing the entry map
     */
    public void setEntryMap(char[] entryMap);

    /**
     * Returns the logical record length (positions 00-04).
     *
     * @return int- the record length
     */
    public int getRecordLength();

    /**
     * Returns the record status (positions 05).
     *
     * @return char- the record status
     */
    public char getRecordStatus();

    /**
     * Returns the record type (position 06).
     *
     * @return char- the record type
     */
    public char getTypeOfRecord();

    /**
     * Returns implementation defined values (positions 07-08).
     *
     * @return char[]- implementation defined values
     */
    public char[] getImplDefined1();

    /**
     * Returns the character coding scheme (position 09).
     *
     * @return char- the character coding scheme
     */
    public char getCharCodingScheme();

    /**
     * Returns the indicator count (positions 10).
     *
     * @return int- the indicator count
     */
    public int getIndicatorCount();

    /**
     * Returns the subfield code length (position 11).
     *
     * @return int- the subfield code length
     */
    public int getSubfieldCodeLength();

    /**
     * Returns the base address of data (positions 12-16).
     *
     * @return int- the base address of data
     */
    public int getBaseAddressOfData();

    /**
     * Returns implementation defined values (positions 17-19).
     *
     * @return char[]- implementation defined values
     */
    public char[] getImplDefined2();

    /**
     * Returns the entry map (positions 20-23).
     *
     * @return char[]- the entry map
     */
    public char[] getEntryMap();

    /**
     * 
     * Creates a leader object from a string object.
     * 
     * 
     * Indicator count and subfield code length are defaulted to 2 if they are
     * not integer values.
     * 
     *
     * @param ldr the leader
     */
    public void unmarshal(String ldr);

    /**
     * Creates a string object from this leader object.
     *
     * @return String - the string object from this leader object
     */
    public String marshal();

}