Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.hivemind.schema
Interface Schema  view Schema download Schema.java

All Superinterfaces:
org.apache.hivemind.parse.AnnotationHolder, org.apache.hivemind.Locatable

public interface Schema
extends org.apache.hivemind.parse.AnnotationHolder, org.apache.hivemind.Locatable

An object which may contain a model, used to identify the form of XML content allowed within some other, containing element.

This is very much provisional; in the future will be more control for validation (i.e, controlling the number of occurances), and support for analogs of W3C SChema sequence and choice. The excess flexibility here forces some validation into element objects (the objects created from the Rules within the ElementModels).


Method Summary
 boolean canInstancesBeKeyed()
          Returns true if Elements conforming to this Schema can be indexed using a key.
 org.apache.hivemind.internal.Module getDefiningModule()
          Return the Module in which the Schema was defined.
 java.util.List getElementModel()
          Returns a List of ElementModel, identifing the elements which may be enclosed by the modeled element.
 java.lang.String getId()
          Returns the (unqualified) id of this schema.
 boolean visibleToModule(java.lang.String moduleId)
          Returns true if the schema is visible to the specified module, false otherwise.
 
Methods inherited from interface org.apache.hivemind.parse.AnnotationHolder
getAnnotation, setAnnotation
 
Methods inherited from interface org.apache.hivemind.Locatable
getLocation
 

Method Detail

getId

public java.lang.String getId()
Returns the (unqualified) id of this schema.

Since:
1.1

getElementModel

public java.util.List getElementModel()
Returns a List of ElementModel, identifing the elements which may be enclosed by the modeled element.

The returned list is unmodifiabled and may be empty, but won't be null.


canInstancesBeKeyed

public boolean canInstancesBeKeyed()
Returns true if Elements conforming to this Schema can be indexed using a key. For this to be true every top-level ElementModel 55 must define a non-null key attribute 55 .

Since:
1.1

visibleToModule

public boolean visibleToModule(java.lang.String moduleId)
Returns true if the schema is visible to the specified module, false otherwise.

Since:
1.1

getDefiningModule

public org.apache.hivemind.internal.Module getDefiningModule()
Return the Module in which the Schema was defined.

Since:
1.1