Home » xmlbeans-2.5.0-src » org.apache » xmlbeans » [javadoc | source]

    1   /*   Copyright 2004 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   
   16   package org.apache.xmlbeans;
   17   
   18   import javax.xml.namespace.QName;
   19   
   20   /**
   21    * Represents a model group.
   22    * <p>
   23    * A model group is a syntactic construct, not a part of
   24    * the logical model. For example, types declared within a
   25    * model group become local to the type that uses the group -
   26    * they're not local to the model group itself. Therefore in
   27    * the logical model of a schema type system, a model group
   28    * doesn't represent anything. Its contents are merged into
   29    * the logical model at parse time.
   30    */
   31   public interface SchemaModelGroup extends SchemaComponent, SchemaAnnotated
   32   {
   33       /**
   34        * Returns SchemaComponent.GROUP.
   35        */
   36       int getComponentType();
   37   
   38       /**
   39        * The name of the model group.
   40        */
   41       QName getName();
   42   
   43       /**
   44        * Used to allow on-demand loading of model groups.
   45        * 
   46        * @exclude
   47        */
   48       public final static class Ref extends SchemaComponent.Ref
   49       {
   50           public Ref(SchemaModelGroup modelGroup)
   51               { super(modelGroup); }
   52   
   53           public Ref(SchemaTypeSystem system, String handle)
   54               { super(system, handle); }
   55   
   56           public final int getComponentType()
   57               { return SchemaComponent.MODEL_GROUP; }
   58   
   59           public final SchemaModelGroup get()
   60               { return (SchemaModelGroup)getComponent(); }
   61       }
   62   
   63       /**
   64        * Returns user-specific information.
   65        * @see SchemaBookmark
   66        */
   67       Object getUserData();
   68   }

Home » xmlbeans-2.5.0-src » org.apache » xmlbeans » [javadoc | source]