SchemaLocationBase (JiBX Java data binding to XML

java.lang.Object
- org.jibx.schema.elements.SchemaBase
- - org.jibx.schema.elements.OpenAttrBase
  - - org.jibx.schema.elements.AnnotatedBase
    - - org.jibx.schema.elements.SchemaLocationBase

All Implemented Interfaces:

IComponent

Direct Known Subclasses:

ImportElement, SchemaLocationRequiredBase
```
public abstract class SchemaLocationBase
extends AnnotatedBase
```
Base class for elements referencing an external schema. Subclasses need to set the referenced schema during the prevalidation pass, so that the referenced schema will be included in the prevalidation processing.

Author:

Dennis M. Sosnoski

Field Summary

Fields
Modifier and Type	Field	Description
`private java.lang.String`	`m_location`	'schemaLocation' attribute value.
`private SchemaElement`	`m_schema`	Referenced schema definition.
`static StringArray`	`s_allowedAttributes`	List of allowed attribute names.

Fields inherited from interface org.jibx.schema.IComponent
SCHEMA_NAMESPACE

Constructor Summary

Constructors
Modifier Constructor Description

protected SchemaLocationBase(int type)
Constructor.

Constructors
Modifier	Constructor	Description
`protected`	`SchemaLocationBase(int type)`	Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract java.lang.String`	`getEffectiveNamespace()`	Get the effective namespace to be applied to the referenced schema.
`java.lang.String`	`getLocation()`	Get 'schemaLocation' attribute value.
`SchemaElement`	`getReferencedSchema()`	Get referenced schema.
`protected SchemaElement`	`readSchema(ValidationContext vctx, ISchemaResolver resolver)`	Load a schema from a resolver.
`void`	`setLocation(java.lang.String location)`	Set 'schemaLocation' attribute value.
`protected void`	`setReferencedSchema(SchemaElement schema)`	Set referenced schema.

Methods inherited from class org.jibx.schema.elements.AnnotatedBase
getAnnotation, getId, prevalidate, setAnnotation, setId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.jibx.schema.elements.OpenAttrBase
addExtraAttribute, clearExtraAttributes, compactChildren, detachChild, getChild, getChildCount, getChildIterator, getChildrenWritable, getExtraAttributes, preget, replaceChild, validateAttributes

Methods inherited from class org.jibx.schema.elements.SchemaBase
addNamespaceDeclaration, bit, clearNamespaceDeclarations, getExtension, getNamespaceDeclarations, getParent, getSchema, isGlobal, name, preset, readNamespaces, setExtension, setParent, type, validate, validateAttributes, writeNamespaces

- Field Detail
  - s_allowedAttributes
```
public static final StringArray s_allowedAttributes
```
    List of allowed attribute names.
  - m_location
```
private java.lang.String m_location
```
    'schemaLocation' attribute value.
  - m_schema
```
private SchemaElement m_schema
```
    Referenced schema definition.
- Constructor Detail
  - SchemaLocationBase
```
protected SchemaLocationBase(int type)
```
    Constructor.
    
    Parameters:
    
    type - element type
- Method Detail
  - getEffectiveNamespace
```
protected abstract java.lang.String getEffectiveNamespace()
```
    Get the effective namespace to be applied to the referenced schema. This must be implemented by subclasses to return the namespace to be applied to the schema, if that namespace is different from what is specified in the schema itself.
    
    Returns:
    
    namespace
  - readSchema
```
protected SchemaElement readSchema(ValidationContext vctx,
                                   ISchemaResolver resolver)
                            throws JiBXException,
                                   java.io.IOException
```
    Load a schema from a resolver.
    
    Parameters:
    
    vctx - validation context
    
    resolver -
    
    Returns:
    
    loaded schema
    
    Throws:
    
    JiBXException
    
    java.io.IOException
  - getLocation
```
public java.lang.String getLocation()
```
    Get 'schemaLocation' attribute value.
    
    Returns:
    
    'schemaLocation' value
  - setLocation
```
public void setLocation(java.lang.String location)
```
    Set 'schemaLocation' attribute value.
    
    Parameters:
    
    location - 'schemaLocation' value
  - setReferencedSchema
```
protected void setReferencedSchema(SchemaElement schema)
```
    Set referenced schema. This method is supplied for the use of subclasses which load the schema through some means other than the 'schemaLocation' attribute value.
    
    Parameters:
    
    schema - schema element
  - getReferencedSchema
```
public SchemaElement getReferencedSchema()
```
    Get referenced schema. This method is only usable after prevalidation.
    
    Returns:
    
    schema (null if loading failed)

Class SchemaLocationBase

Field Summary

Fields inherited from interface org.jibx.schema.IComponent

Fields inherited from class org.jibx.schema.elements.SchemaBase

Constructor Summary

Method Summary

Methods inherited from class org.jibx.schema.elements.AnnotatedBase

Methods inherited from class java.lang.Object

Methods inherited from class org.jibx.schema.elements.OpenAttrBase

Methods inherited from class org.jibx.schema.elements.SchemaBase

Field Detail

s_allowedAttributes

m_location

m_schema

Constructor Detail

SchemaLocationBase

Method Detail

getEffectiveNamespace

readSchema

getLocation

setLocation

setReferencedSchema

getReferencedSchema