com.saxonica.schema
Interface ComponentReference

All Superinterfaces:
SourceLocator
All Known Implementing Classes:
AttributeGroupReference, AttributeUse, Edge.MaxOccursParticle, ElementParticle, ElementWildcard, IdentityConstraintReference, KeyRef, ModelGroupParticle, Particle, SimpleComponentReference, TypeReference

public interface ComponentReference
extends SourceLocator

A reference to a schema component. The reference may have been resolved to a specific component, or may be as yet unresolved. Any attempt to use a reference that has not yet been resolved causes an unchecked exception.


Method Summary
 EnterpriseConfiguration getConfiguration()
          Determine the configuration containing this reference (and its target)
 int getFingerprint()
          Get the fingerprint of the target of this reference
 int getSymbolSpace()
          Get the symbol space of the target of this reference
 SchemaComponent getTarget()
          Get the schema component identified by this reference.
 boolean isResolved()
          Determine whether this reference has been resolved
 void tryToResolve(SchemaCompiler compiler)
          Try to resolve the reference if possible, relative to components present in a given schema.
 
Methods inherited from interface javax.xml.transform.SourceLocator
getColumnNumber, getLineNumber, getPublicId, getSystemId
 

Method Detail

getConfiguration

EnterpriseConfiguration getConfiguration()
Determine the configuration containing this reference (and its target)

Returns:
the Saxon configuration

tryToResolve

void tryToResolve(SchemaCompiler compiler)
Try to resolve the reference if possible, relative to components present in a given schema. No error occurs if the reference cannot yet be resolved.

Parameters:
compiler - The compiler being used to compile the referring component. This is assumed to know about the schema containing the candidate target components for the reference. If null, the schema containing the reference is used.

isResolved

boolean isResolved()
Determine whether this reference has been resolved

Returns:
true if the reference has been resolved to a schema component

getTarget

SchemaComponent getTarget()
                          throws UnresolvedReferenceException
Get the schema component identified by this reference.

Returns:
the schema component if the reference has been resolved.
Throws:
UnresolvedReferenceException - if the reference has not been resolved. Note that this is an unchecked exception.

getFingerprint

int getFingerprint()
Get the fingerprint of the target of this reference

Returns:
the integer fingerprint of the component name

getSymbolSpace

int getSymbolSpace()
Get the symbol space of the target of this reference

Returns:
an integer code identifying the symbol space


Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.