KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > conf > ConfigLoaderDelegate


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */
56
57 package org.objectstyle.cayenne.conf;
58
59 import java.util.Map JavaDoc;
60
61 /**
62  * Interface that defines callback API used by ConfigLoader to process loaded
63  * configuration. Main responsibility of ConfigLoaderDelegate is to create
64  * objects, while ConfigLoader is mainly concerned with XML parsing.
65  *
66  * @author Andrei Adamchik
67  */
68 public interface ConfigLoaderDelegate {
69     /**
70      * Callback methods invoked in the beginning of the configuration
71      * processing.
72      */
73     public void startedLoading();
74
75     /**
76      * Callback methods invoked at the end of the configuration processing.
77      */
78     public void finishedLoading();
79
80     /**
81      * Callback method invoked when a project version is read.
82      * @since 1.1
83      */
84     public void shouldLoadProjectVersion(String JavaDoc version);
85         
86     /**
87      * Callback method invoked when a domain is encountered in the configuration
88      * file.
89      * @param name domain name.
90      */
91     public void shouldLoadDataDomain(String JavaDoc name);
92     
93     /**
94      * Callback method invoked when a DataView reference is encountered in the configuration
95      * file.
96      *
97      * @since 1.1
98      */
99     public void shouldRegisterDataView(String JavaDoc name, String JavaDoc location);
100
101     /**
102      * @since 1.1
103      */
104     public void shouldLoadDataMaps(String JavaDoc domainName, Map JavaDoc locations);
105     
106     /**
107      * @since 1.1
108      */
109     public void shouldLoadDataDomainProperties(String JavaDoc domainName, Map JavaDoc properties);
110
111     public void shouldLoadDataNode(
112         String JavaDoc domainName,
113         String JavaDoc nodeName,
114         String JavaDoc dataSource,
115         String JavaDoc adapter,
116         String JavaDoc factory);
117
118     public void shouldLinkDataMap(
119         String JavaDoc domainName,
120         String JavaDoc nodeName,
121         String JavaDoc mapName);
122
123     /**
124      * Gives delegate an opportunity to process the error.
125      *
126      * @param th
127      * @return boolean indicating whether ConfigLoader should proceed with
128      * further processing. Ultimately it is up to the ConfigLoader to make this
129      * decision.
130      */
131     public boolean loadError(Throwable JavaDoc th);
132
133     /**
134      * @return status object indicating the state of the configuration loading.
135      */
136     public ConfigStatus getStatus();
137 }
138
Popular Tags