001: /*
002: License $Id: I_Element.java,v 1.6 2004/09/27 01:34:11 hendriks73 Exp $
003:
004: Copyright (c) 2001-2005 tagtraum industries.
005:
006: LGPL
007: ====
008:
009: jo! is free software; you can redistribute it and/or
010: modify it under the terms of the GNU Lesser General Public
011: License as published by the Free Software Foundation; either
012: version 2.1 of the License, or (at your option) any later version.
013:
014: jo! is distributed in the hope that it will be useful,
015: but WITHOUT ANY WARRANTY; without even the implied warranty of
016: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017: Lesser General Public License for more details.
018:
019: You should have received a copy of the GNU Lesser General Public
020: License along with this library; if not, write to the Free Software
021: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
022:
023: For LGPL see <http://www.fsf.org/copyleft/lesser.txt>
024:
025:
026: Sun license
027: ===========
028:
029: This release contains software by Sun Microsystems. Therefore
030: the following conditions have to be met, too. They apply to the
031: files
032:
033: - lib/mail.jar
034: - lib/activation.jar
035: - lib/jsse.jar
036: - lib/jcert.jar
037: - lib/jaxp.jar
038: - lib/crimson.jar
039: - lib/servlet.jar
040: - lib/jnet.jar
041: - lib/jaas.jar
042: - lib/jaasmod.jar
043:
044: contained in this release.
045:
046: a. Licensee may not modify the Java Platform
047: Interface (JPI, identified as classes contained within the javax
048: package or any subpackages of the javax package), by creating additional
049: classes within the JPI or otherwise causing the addition to or modification
050: of the classes in the JPI. In the event that Licensee creates any
051: Java-related API and distribute such API to others for applet or
052: application development, you must promptly publish broadly, an accurate
053: specification for such API for free use by all developers of Java-based
054: software.
055:
056: b. Software is confidential copyrighted information of Sun and
057: title to all copies is retained by Sun and/or its licensors. Licensee
058: shall not modify, decompile, disassemble, decrypt, extract, or otherwise
059: reverse engineer Software. Software may not be leased, assigned, or
060: sublicensed, in whole or in part. Software is not designed or intended
061: for use in on-line control of aircraft, air traffic, aircraft navigation
062: or aircraft communications; or in the design, construction, operation or
063: maintenance of any nuclear facility. Licensee warrants that it will not
064: use or redistribute the Software for such purposes.
065:
066: c. Software is provided "AS IS," without a warranty
067: of any kind. ALL EXPRESS OR IMPLIED REPRESENTATIONS AND WARRANTIES,
068: INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
069: PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED.
070:
071: d. This License is effective until terminated. Licensee may
072: terminate this License at any time by destroying all copies of Software.
073: This License will terminate immediately without notice from Sun if Licensee
074: fails to comply with any provision of this License. Upon such termination,
075: Licensee must destroy all copies of Software.
076:
077: e. Software, including technical data, is subject to U.S.
078: export control laws, including the U.S. Export Administration Act and its
079: associated regulations, and may be subject to export or import regulations
080: in other countries. Licensee agrees to comply strictly with all such
081: regulations and acknowledges that it has the responsibility to obtain
082: licenses to export, re-export, or import Software. Software may not be
083: downloaded, or otherwise exported or re-exported (i) into, or to a national
084: or resident of, Cuba, Iraq, Iran, North Korea, Libya, Sudan, Syria or any
085: country to which the U.S. has embargoed goods; or (ii) to anyone on the
086: U.S. Treasury Department's list of Specially Designated Nations or the U.S.
087: Commerce Department's Table of Denial Orders.
088:
089:
090: Feedback
091: ========
092:
093: We encourage your feedback and suggestions and want to use your feedback to
094: improve the Software. Send all such feedback to:
095: <feedback@tagtraum.com>
096:
097: For more information on tagtraum industries and jo!
098: please see <http://www.tagtraum.com/>.
099:
100:
101: */
102: package com.tagtraum.framework.markup;
103:
104: import com.tagtraum.framework.util.FileLocation;
105:
106: import java.io.IOException;
107: import java.io.PushbackReader;
108: import java.util.Enumeration;
109:
110: /**
111: * An <code>I_Element</code> is an object returned by the method
112: * {@link Parser#nextElement()}. It represents a part of a text -
113: * a token. To recognize the kind of element each element should have a
114: * name.
115: *
116: * @author <a href="mailto:hs@tagtraum.com">Hendrik Schreiber</a>
117: * @version 1.1beta1 $Id: I_Element.java,v 1.6 2004/09/27 01:34:11 hendriks73 Exp $
118: * @see RawDataElement
119: * @see I_Tag
120: */
121: public interface I_Element {
122:
123: /**
124: * Source-Version
125: */
126: public static String vcid = "$Id: I_Element.java,v 1.6 2004/09/27 01:34:11 hendriks73 Exp $";
127:
128: /**
129: * Returns the name of this tag. I.e. P for <p>.
130: */
131: public String getName();
132:
133: /**
134: * Returns the type of this tag.
135: */
136: public int getType();
137:
138: /**
139: * Parses the current element.
140: */
141: public void parse(PushbackReader in) throws IOException;
142:
143: /**
144: * Returns the length. This method should only be called after
145: * {@link #parse}.
146: */
147: public int getLength();
148:
149: /**
150: * Returns the data. This method should only be called after
151: * {@link #parse}.
152: */
153: public String getData();
154:
155: /**
156: * Returns the start characters of a tag.
157: */
158: public String getTagStart();
159:
160: /**
161: * Returns the end characters of a tag.
162: */
163: public String getTagEnd();
164:
165: public int getLine();
166:
167: public void setLine(int line);
168:
169: public FileLocation getFileLocation();
170:
171: public void setFileLocation(FileLocation location);
172:
173: /* -- tree related methods -- */
174:
175: /**
176: * Method.
177: *
178: *
179: * @return
180: *
181: * @see
182: */
183: public I_Element getParent();
184:
185: /**
186: * Method.
187: *
188: *
189: * @param aParent
190: *
191: * @see
192: */
193: public void setParent(I_Element aParent);
194:
195: /**
196: * Method.
197: *
198: *
199: * @return
200: *
201: * @see
202: */
203: public boolean isRoot();
204:
205: /**
206: * Method.
207: *
208: *
209: * @return
210: *
211: * @see
212: */
213: public boolean isLeaf();
214:
215: /**
216: * Method.
217: *
218: *
219: * @param aChild
220: *
221: * @see
222: */
223: public void addChild(I_Element aChild);
224:
225: /**
226: * Method.
227: *
228: *
229: * @param idx
230: *
231: * @return
232: *
233: * @see
234: */
235: public I_Element getChild(int idx);
236:
237: /**
238: * Method.
239: *
240: *
241: * @param idx
242: *
243: * @return
244: *
245: * @see
246: */
247: public I_Element removeChild(int idx);
248:
249: /**
250: * Method.
251: *
252: *
253: * @return
254: *
255: * @see
256: */
257: public Enumeration getChildren();
258:
259: /**
260: * Method.
261: *
262: *
263: * @return
264: *
265: * @see
266: */
267: public int getChildrenCount();
268:
269: /**
270: * Method.
271: *
272: *
273: * @return
274: *
275: * @see
276: */
277: public I_Element getFirstChild();
278:
279: }
|