001: /**
002: * Redistribution and use of this software and associated documentation
003: * ("Software"), with or without modification, are permitted provided
004: * that the following conditions are met:
005: *
006: * 1. Redistributions of source code must retain copyright
007: * statements and notices. Redistributions must also contain a
008: * copy of this document.
009: *
010: * 2. Redistributions in binary form must reproduce the
011: * above copyright notice, this list of conditions and the
012: * following disclaimer in the documentation and/or other
013: * materials provided with the distribution.
014: *
015: * 3. The name "Exolab" must not be used to endorse or promote
016: * products derived from this Software without prior written
017: * permission of Intalio, Inc. For written permission,
018: * please contact info@exolab.org.
019: *
020: * 4. Products derived from this Software may not be called "Exolab"
021: * nor may "Exolab" appear in their names without prior written
022: * permission of Intalio, Inc. Exolab is a registered
023: * trademark of Intalio, Inc.
024: *
025: * 5. Due credit should be given to the Exolab Project
026: * (http://www.exolab.org/).
027: *
028: * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
029: * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
030: * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
031: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
032: * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
033: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
034: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
035: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
036: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
037: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
038: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
039: * OF THE POSSIBILITY OF SUCH DAMAGE.
040: *
041: * Copyright 2002 (C) Intalio, Inc. All Rights Reserved.
042: *
043: * $Id: SchemaLocation.java 6230 2006-09-19 07:56:07Z wguttmn $
044: */package org.exolab.castor.xml.schema.reader;
045:
046: import java.io.Reader;
047:
048: import org.exolab.castor.net.URILocation;
049: import org.exolab.castor.net.util.URIUtils;
050: import org.exolab.castor.xml.schema.Schema;
051:
052: /**
053: * An implementation of URILocation for applications that
054: * need to resolve an XML Schema in a non-standard way, such
055: * as a Schema embedded in another XML document, or a
056: * Schema created in-memory, etc.
057: *
058: * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
059: * @version $Revision: 6230 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $
060: */
061: public final class SchemaLocation extends URILocation {
062:
063: private String _documentBase = null;
064: private String _absoluteURI = null;
065: private String _relativeURI = null;
066:
067: /**
068: * A reference to an alread loaded schema
069: */
070: private Schema _schema = null;
071:
072: /**
073: * Creates a new SchemaLocation
074: *
075: * @param schema the Schema that represents the resource at
076: * identified by this URILocation
077: * @param href the absolute URL for the resource identified by
078: * this URILocation.
079: */
080: public SchemaLocation(Schema schema, String href) {
081: if (schema == null)
082: throw new IllegalStateException(
083: "argument 'schema' must not be null.");
084:
085: _schema = schema;
086:
087: if (href != null) {
088: _absoluteURI = URIUtils.resolveAsString(href, null);
089: }
090: } //-- SchemaLocation
091:
092: /**
093: * Returns the absolute URI for this URILocation
094: *
095: * @return the absolute URI for this URILocation
096: * @see #getRelativeURI
097: * @see #getBaseURI
098: **/
099: public String getAbsoluteURI() {
100: return _absoluteURI;
101: } //-- getAbsoluteURI
102:
103: /**
104: * Returns the base location of this URILocation.
105: * If this URILocation is an URL, the base location
106: * will be equivalent to the document base for the URL.
107: *
108: * @return the base location of this URILocation
109: * @see #getAbsoluteURI
110: * @see #getRelativeURI
111: **/
112: public String getBaseURI() {
113: if (_documentBase == null) {
114: if (_absoluteURI != null) {
115: _documentBase = URIUtils.getDocumentBase(_absoluteURI);
116: }
117: }
118: return _documentBase;
119: } //-- getBaseURI
120:
121: /**
122: * Returns a Reader for the resource represented
123: * by this URILocation.
124: *
125: * Note: This method always returns null for this
126: * URILocation
127: *
128: * @return a Reader for the resource represented by
129: * this URILocation
130: * @exception java.io.FileNotFoundException
131: * @exception java.io.IOException
132: **/
133: public Reader getReader() throws java.io.IOException {
134: return null; //-- Not Supported by this URILocation
135: } //-- getReader
136:
137: /**
138: * Returns the relative URI for this URILocation
139: *
140: * @return the relative URI for this URILocation
141: * @see #getAbsoluteURI
142: * @see #getBaseURI
143: **/
144: public String getRelativeURI() {
145:
146: if (_relativeURI == null) {
147: if (_absoluteURI != null) {
148: int idx = getBaseURI().length();
149: _relativeURI = _absoluteURI.substring(idx);
150: }
151: }
152:
153: return _relativeURI;
154:
155: } //-- getRelativeURI
156:
157: /**
158: * Returns the Schema for this SchemaLocation, or null if
159: * this SchemaLocation was not constructed with a Schema object.
160: *
161: * @return the Schema for this SchemaLocation, or null if
162: * no Schema object was set.
163: */
164: public Schema getSchema() {
165: return _schema;
166: } //-- getSchema
167:
168: /**
169: * Returns the String representation of
170: * this URILocation.
171: *
172: * @return the String representation of this URILocation
173: **/
174: public String toString() {
175: if (_absoluteURI != null)
176: return _absoluteURI;
177: return "URILocation: " + _schema.toString();
178: }
179:
180: } //-- SchemaLocation
|