Use field variable with qualified field name. FIX namespace!
[marc4j.git] / src / org / marc4j / marc / VariableField.java
1 //$Id: VariableField.java,v 1.10 2006/08/04 12:28:17 bpeters Exp $\r
2 /**\r
3  * Copyright (C) 2004 Bas Peters\r
4  *\r
5  * This file is part of MARC4J\r
6  *\r
7  * MARC4J is free software; you can redistribute it and/or\r
8  * modify it under the terms of the GNU Lesser General Public \r
9  * License as published by the Free Software Foundation; either \r
10  * version 2.1 of the License, or (at your option) any later version.\r
11  *\r
12  * MARC4J is distributed in the hope that it will be useful,\r
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r
15  * Lesser General Public License for more details.\r
16  *\r
17  * You should have received a copy of the GNU Lesser General Public \r
18  * License along with MARC4J; if not, write to the Free Software\r
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
20  */\r
21 package org.marc4j.marc;\r
22 \r
23 import java.io.Serializable;\r
24 \r
25 /**\r
26  * Represents a variable field in a MARC record.\r
27  * \r
28  * @author Bas Peters\r
29  * @version $Revision: 1.10 $\r
30  */\r
31 @SuppressWarnings("rawtypes")\r
32 public interface VariableField extends Serializable, Comparable {\r
33 \r
34     /**\r
35      * Sets the identifier.\r
36      * \r
37      * <p>\r
38      * The purpose of this identifier is to provide an identifier for\r
39      * persistency.\r
40      * \r
41      * @param id\r
42      *            the identifier\r
43      */\r
44     public void setId(Long id);\r
45 \r
46     /**\r
47      * Returns the identifier.\r
48      * \r
49      * @return Long - the identifier\r
50      */\r
51     public Long getId();\r
52 \r
53     /**\r
54      * Returns the tag name.\r
55      * \r
56      * @return String - the tag name\r
57      */\r
58     public String getTag();\r
59 \r
60     /**\r
61      * Sets the tag name.\r
62      * \r
63      * @param tag\r
64      *            the tag name\r
65      */\r
66     public void setTag(String tag);\r
67 \r
68     /**\r
69      * Returns true if the given regular expression matches a subsequence of a\r
70      * data element within the variable field.\r
71      * \r
72      * <p>\r
73      * See {@link java.util.regex.Pattern} for more information about Java\r
74      * regular expressions.\r
75      * </p>\r
76      * \r
77      * @param pattern\r
78      *            the regular expression\r
79      * @return true if the pattern matches, false othewise\r
80      */\r
81     public abstract boolean find(String pattern);\r
82 \r
83 }\r