01: // Copyright 2004, 2005 The Apache Software Foundation
02: //
03: // Licensed under the Apache License, Version 2.0 (the "License");
04: // you may not use this file except in compliance with the License.
05: // You may obtain a copy of the License at
06: //
07: // http://www.apache.org/licenses/LICENSE-2.0
08: //
09: // 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.hivemind.schema;
16:
17: import java.util.List;
18:
19: import org.apache.hivemind.Locatable;
20: import org.apache.hivemind.internal.Module;
21: import org.apache.hivemind.parse.AnnotationHolder;
22:
23: /**
24: * An object which may contain a model, used to identify the form of XML content allowed within some
25: * other, containing element.
26: * <p>
27: * This is very much provisional; in the future will be more control for validation (i.e,
28: * controlling the number of occurances), and support for analogs of W3C SChema sequence and choice.
29: * The excess flexibility here forces some validation into element objects (the objects created from
30: * the {@link org.apache.hivemind.schema.Rule}s within the
31: * {@link org.apache.hivemind.schema.ElementModel}s).
32: *
33: * @author Howard Lewis Ship
34: */
35: public interface Schema extends AnnotationHolder, Locatable {
36: /**
37: * Returns the (unqualified) id of this schema.
38: *
39: * @since 1.1
40: */
41: public String getId();
42:
43: /**
44: * Returns a List of {@link ElementModel}, identifing the elements which may be enclosed by the
45: * modeled element.
46: * <p>
47: * The returned list is unmodifiabled and may be empty, but won't be null.
48: */
49: public List getElementModel();
50:
51: /**
52: * Returns true if Elements conforming to this Schema can be indexed using a key. For this to be
53: * true every {@link #getElementModel() top-level ElementModel} must define a non-null
54: * {@link ElementModel#getKeyAttribute() key attribute}.
55: *
56: * @since 1.1
57: */
58: public boolean canInstancesBeKeyed();
59:
60: /**
61: * Returns true if the schema is visible to the specified module, false otherwise.
62: *
63: * @since 1.1
64: */
65: public boolean visibleToModule(String moduleId);
66:
67: /**
68: *
69: * Return the Module in which the Schema was defined.
70: *
71: * @since 1.1
72: *
73: */
74:
75: public Module getDefiningModule();
76: }
|