KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > portal > setup > sl > SchemaLoaderConfig


1 /*****************************************
2  * *
3  * JBoss Portal: The OpenSource Portal *
4  * *
5  * Distributable under LGPL license. *
6  * See terms of license at gnu.org. *
7  * *
8  *****************************************/
9 package org.jboss.portal.setup.sl;
10
11 import org.jboss.portal.setup.PortalSetupException;
12 import org.jboss.portal.setup.config.Configuration;
13
14 import java.util.List JavaDoc;
15 import java.net.MalformedURLException JavaDoc;
16 import java.io.FileNotFoundException JavaDoc;
17
18 /**
19  * @author <a HREF="mailto:palber@novell.com">Polina Alber</a>
20  * Date: Apr 13, 2005; Time: 12:28:53 AM
21  * @since JBoss portal 2.0
22  * Interface org.jboss.portal.setup.sl.SchemaLoaderConfig is an abstraction of schema loader configuration.
23  */
24 public interface SchemaLoaderConfig extends Configuration
25 {
26
27    /**
28     * @param classname a name of a class that implements <code>SchemaLoader</code>
29     */
30    void setSchemaLoaderClass(String JavaDoc classname);
31
32    /**
33     * @return a name of a class that implements <code>SchemaLoader</code>
34     */
35    String JavaDoc getSchemaLoaderClass();
36
37
38    /**
39     * @return a rule of schema loading; supported rules are new only, always (reloads every time),
40     * update
41     */
42    String JavaDoc getSchemaLoadRule();
43
44    /**
45     * @param rule of schema loading; supported rules are new only, always (reloads every time),
46     * update
47     */
48    void setSchemaLoadRule(String JavaDoc rule) throws PortalSetupException;
49
50
51    /**
52     * @return a schema validation query string
53     */
54    String JavaDoc getSchemaQueryString();
55
56    /**
57     * @param queryStr a schema validation query string
58     */
59    void setSchemaQueryString(String JavaDoc queryStr);
60
61    /**
62     * @return schema loader rule converted to an enum value
63     */
64    SchemaLoadType getSchemaLoadType();
65
66    /**
67     * Set a type of schema loading; supported types are new only, always (reloads every time),
68     * never (never performs schema load)
69     */
70    public void setSchemaLoadType(String JavaDoc type) throws PortalSetupException;
71
72
73    /**
74     * return a <code>List</code> of schema files URI;
75     * may include a directory uri, where all data load files are located.
76     */
77    List JavaDoc getSchemaLoadURIs();
78
79    /**
80     * @param schemaFileURI - a String that defines file URI, or dirrectory URI
81     * where load data files are located.Does not perform scanning of a directory all the time.
82     * gets directory file list only once upon addition.
83     * @throws PortalSetupException if URI cannot be resolved
84     */
85    public void addSchemaLoadURI(String JavaDoc schemaFileURI) throws PortalSetupException;
86
87    /**
88     * @param schemaFilesURIs - a <code>List</code> of Strings that defines either file URI, or dirrectory URI
89     * where schema files are located.Does not perform scanning of a directory all the time.
90     * gets directory file list only once upon addition.
91     * @throws PortalSetupException if URI cannot be resolved
92     */
93    public void setSchemaLoadURIs(List JavaDoc schemaFilesURIs) throws PortalSetupException;
94
95    /**
96     * @return a <code>List</code> of strings, that defines schema file name pattern, like
97     * '*.hbm.xml, *.ddl' - supported by a type of schema loader this configuration reffers to.
98     */
99    public List JavaDoc getSchemaFilePattern();
100
101
102 }
103
Popular Tags