01: /*
02: * DSpaceTransformer.java
03: *
04: * Version: $Revision: 1.5 $
05: *
06: * Date: $Date: 2005/11/16 22:20:46 $
07: *
08: * Copyright (c) 2002, Hewlett-Packard Company and Massachusetts
09: * Institute of Technology. All rights reserved.
10: *
11: * Redistribution and use in source and binary forms, with or without
12: * modification, are permitted provided that the following conditions are
13: * met:
14: *
15: * - Redistributions of source code must retain the above copyright
16: * notice, this list of conditions and the following disclaimer.
17: *
18: * - Redistributions in binary form must reproduce the above copyright
19: * notice, this list of conditions and the following disclaimer in the
20: * documentation and/or other materials provided with the distribution.
21: *
22: * - Neither the name of the Hewlett-Packard Company nor the name of the
23: * Massachusetts Institute of Technology nor the names of their
24: * contributors may be used to endorse or promote products derived from
25: * this software without specific prior written permission.
26: *
27: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28: * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31: * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
32: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
33: * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
34: * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
35: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
36: * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
37: * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
38: * DAMAGE.
39: */
40:
41: package org.dspace.app.xmlui.cocoon;
42:
43: import java.io.IOException;
44: import java.sql.SQLException;
45:
46: import org.dspace.app.xmlui.utils.UIException;
47: import org.dspace.app.xmlui.wing.WingException;
48: import org.dspace.app.xmlui.wing.WingTransformer;
49: import org.dspace.app.xmlui.wing.element.Body;
50: import org.dspace.app.xmlui.wing.element.Options;
51: import org.dspace.app.xmlui.wing.element.PageMeta;
52: import org.dspace.app.xmlui.wing.element.UserMeta;
53: import org.dspace.authorize.AuthorizeException;
54: import org.xml.sax.SAXException;
55:
56: /**
57: *
58: * The WingTransformer is a simple framework for dealing with DSpace based SAX
59: * events. The implementing class is responsable for catching the approprate
60: * events and filtering them into these method calls. This allows implementors
61: * to have easy access to the document without dealing with the messyness of the
62: * sax event system.
63: *
64: * @author Scott Phillips
65: */
66: public interface DSpaceTransformer extends WingTransformer {
67:
68: /** What to add at the end of the body */
69: public void addBody(Body body) throws SAXException, WingException,
70: UIException, SQLException, IOException, AuthorizeException;
71:
72: /** What to add to the options list */
73: public void addOptions(Options options) throws SAXException,
74: WingException, UIException, SQLException, IOException,
75: AuthorizeException;
76:
77: /** What user metadata to add to the document */
78: public void addUserMeta(UserMeta userMeta) throws SAXException,
79: WingException, UIException, SQLException, IOException,
80: AuthorizeException;
81:
82: /** What page metadata to add to the document */
83: public void addPageMeta(PageMeta pageMeta) throws SAXException,
84: WingException, UIException, SQLException, IOException,
85: AuthorizeException;
86:
87: /** What is a unique name for this component? */
88: public String getComponentName();
89:
90: }
|