KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > engine > ISpecificationSource


1 // Copyright 2004, 2005 The Apache Software Foundation
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 package org.apache.tapestry.engine;
16
17 import org.apache.hivemind.Resource;
18 import org.apache.tapestry.INamespace;
19 import org.apache.tapestry.spec.IComponentSpecification;
20 import org.apache.tapestry.spec.ILibrarySpecification;
21
22 /**
23  * Defines access to component specifications.
24  *
25  * @see IComponentSpecification
26  *
27  * @author Howard Lewis Ship
28  *
29  **/
30
31 public interface ISpecificationSource
32 {
33     /**
34      * Retrieves a component specification, parsing it as necessary.
35      *
36      * @param specificationLocation the location where the specification
37      * may be read from.
38      *
39      * @throws org.apache.tapestry.ApplicationRuntimeException if the specification doesn't
40      * exist, is unreadable or invalid.
41      *
42      * @since 2.2
43      *
44      **/
45
46     public IComponentSpecification getComponentSpecification(Resource specificationLocation);
47
48     /**
49      * Retrieves a component specification, parsing it as necessary.
50      *
51      * @param specificationLocation the location where the specification
52      * may be read from.
53      *
54      * @throws org.apache.tapestry.ApplicationRuntimeException if the specification doesn't
55      * exist, is unreadable or invalid.
56      *
57      * @since 2.2
58      *
59      **/
60
61     public IComponentSpecification getPageSpecification(Resource specificationLocation);
62
63     /**
64      * Returns a {@link org.apache.tapestry.spec.LibrarySpecification} with the given path.
65      *
66      * @param specificationLocation the resource path of the specification
67      * to return
68      * @throws org.apache.tapestry.ApplicationRuntimeException if the specification
69      * cannot be read
70      *
71      * @since 2.2
72      *
73      **/
74
75     public ILibrarySpecification getLibrarySpecification(Resource specificationLocation);
76
77     /**
78      * Returns the {@link INamespace} for the application.
79      *
80      * @since 2.2
81      *
82      **/
83
84     public INamespace getApplicationNamespace();
85
86     /**
87      * Returns the {@link INamespace} for the framework itself.
88      *
89      * @since 2.2
90      *
91      **/
92
93     public INamespace getFrameworkNamespace();
94 }
Popular Tags