01: /*
02: * <copyright>
03: *
04: * Copyright 2001-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26: package org.cougaar.planning.servlet.data.xml;
27:
28: import org.xml.sax.Attributes;
29:
30: /**
31: * Classes conforming to this interface can DEserialize themselves
32: * from a slightly restricted XML format.<P>
33: * The XML format used, does not allow character data between or
34: * following nested tags. For example: <P>
35: * <PRE>
36: * <A>OK
37: * <B>OK</B>
38: * NOT OK
39: * <C>OK</C>
40: * NOT OK
41: * </A>
42: * </PRE>
43: * <BR><P>
44: *
45: *
46: * @since 1/24/01
47: **/
48: public interface DeXMLable {
49:
50: /**
51: * Report a startElement that pertains to THIS object, not any
52: * sub objects. Call also provides the elements Attributes and data.
53: * Note, that unlike in a SAX parser, data is guaranteed to contain
54: * ALL of this tag's data, not just a 'chunk' of it.
55: * @param name startElement tag
56: * @param attr attributes for this tag
57: * @param data data for this tag
58: **/
59: void openTag(String name, Attributes attr, String data)
60: throws UnexpectedXMLException;
61:
62: /**
63: * Report an endElement.
64: * @param name endElement tag
65: * @return true iff the object is DONE being deXMLized
66: **/
67: boolean closeTag(String name) throws UnexpectedXMLException;
68:
69: /**
70: * This function will be called whenever a subobject has
71: * completed de-XMLizing and needs to be encorporated into
72: * this object.
73: * @param name the startElement tag that caused this subobject
74: * to be created
75: * @param obj the object itself
76: **/
77: void completeSubObject(String name, DeXMLable obj)
78: throws UnexpectedXMLException;
79: }
|