info.freelibrary.marc4j.impl.SubfieldImpl Maven / Gradle / Ivy

Go to download
/**
 * 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 info.freelibrary.marc4j.impl;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.marc4j.marc.Subfield;

/**
 * Represents a subfield in a MARC record.
 * 
 * @author Bas Peters
 */
public class SubfieldImpl implements Subfield {

    private Long id;

    private char code;

    private String data;

    /**
     * Creates a new Subfield.
     */
    public SubfieldImpl() {
    }

    /**
     * Creates a new Subfield and sets the data element identifier.
     * 
     * @param code the data element identifier
     */
    public SubfieldImpl(final char code) {
        this.setCode(code);
    }

    /**
     * Creates a new Subfield and sets the data element identifier
     * and the data element.
     * 
     * @param code the data element identifier
     * @param data the data element
     */
    public SubfieldImpl(final char code, final String data) {
        this.setCode(code);
        this.setData(data);
    }

    /**
     * Sets the {@link Subfield} code.
     */
    @Override
    public void setCode(final char code) {
        this.code = code;
    }

    /**
     * Gets the {@link Subfield} code.
     */
    @Override
    public char getCode() {
        return code;
    }

    /**
     * Sets the {@link Subfield} data.
     */
    @Override
    public void setData(final String data) {
        this.data = data;
    }

    /**
     * Gets the {@link Subfield} data.
     */
    @Override
    public String getData() {
        return data;
    }

    /**
     * Returns true is the supplied regular expression pattern
     * matches the {@link Subfield} data; else, false.
     */
    @Override
    public boolean find(final String pattern) {
        final Pattern p = Pattern.compile(pattern);
        final Matcher m = p.matcher(getData());

        return m.find();
    }

    /**
     * Returns a string representation of this subfield.
     * 
     * Example:
     * 
     * 
     * $aSummerland /
     * 
     * 
     * @return String - a string representation of this subfield
     */
    @Override
    public String toString() {
        return "$" + getCode() + getData();
    }

    /**
     * Sets the ID for this {@link Subfield}.
     */
    @Override
    public void setId(final Long id) {
        this.id = id;
    }

    /**
     * Gets the ID for this {@link Subfield}.
     */
    @Override
    public Long getId() {
        return id;
    }

}