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: * Factory that produces sub-objects based on tags and attributes
32: *
33: * @since 1/24/01
34: **/
35: public interface DeXMLableFactory {
36:
37: //Variables:
38: ////////////
39:
40: //Members:
41: //////////
42:
43: /**
44: * This is a look ahead to see if we should start a sub object.
45: * The caller will first call this function on startElement. If
46: * this function returns null, the startElement will be reported
47: * to the current object with a call to openTag(...). Otherwise
48: * this function should return a new DeXMLable subobject that
49: * further output will be deligated to, until the subobject returns
50: * true from a call to endElement().
51: *
52: * @param name startElement tag
53: * @param attr startElement attributes
54: * @return a new DeXMLable subobject if a subobject should be created,
55: * otherwise null.
56: **/
57: DeXMLable beginSubObject(DeXMLable curObj, String name,
58: Attributes attr) throws UnexpectedXMLException;
59: }
|