org.apache.xmlbeans.SchemaModelGroup Maven / Gradle / Ivy
/* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.xmlbeans;
import javax.xml.namespace.QName;
/**
* Represents a model group.
*
* A model group is a syntactic construct, not a part of
* the logical model. For example, types declared within a
* model group become local to the type that uses the group -
* they're not local to the model group itself. Therefore in
* the logical model of a schema type system, a model group
* doesn't represent anything. Its contents are merged into
* the logical model at parse time.
*/
public interface SchemaModelGroup extends SchemaComponent, SchemaAnnotated
{
/**
* Returns SchemaComponent.GROUP.
*/
int getComponentType();
/**
* The name of the model group.
*/
QName getName();
/**
* Used to allow on-demand loading of model groups.
*
* @exclude
*/
public final static class Ref extends SchemaComponent.Ref
{
public Ref(SchemaModelGroup modelGroup)
{ super(modelGroup); }
public Ref(SchemaTypeSystem system, String handle)
{ super(system, handle); }
public final int getComponentType()
{ return SchemaComponent.MODEL_GROUP; }
public final SchemaModelGroup get()
{ return (SchemaModelGroup)getComponent(); }
}
/**
* Returns user-specific information.
* @see SchemaBookmark
*/
Object getUserData();
}