org.apache.xerces.impl.xs.XSAnnotationImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xerces2-xsd11 Show documentation
Show all versions of xerces2-xsd11 Show documentation
A processor for parsing, validating, serializing and manipulating XML, written in Java
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.xerces.impl.xs;
import java.io.IOException;
import java.io.StringReader;
import org.apache.xerces.dom.CoreDocumentImpl;
import org.apache.xerces.parsers.DOMParser;
import org.apache.xerces.parsers.SAXParser;
import org.apache.xerces.xs.XSAnnotation;
import org.apache.xerces.xs.XSConstants;
import org.apache.xerces.xs.XSNamespaceItem;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.xml.sax.ContentHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/**
* This is an implementation of the XSAnnotation schema component.
*
* @xerces.internal
*
* @version $Id$
*/
public class XSAnnotationImpl implements XSAnnotation {
// Data
// the content of the annotation node, including all children, along
// with any non-schema attributes from its parent
private String fData = null;
// the grammar which owns this annotation; we get parsers
// from here when we need them
private SchemaGrammar fGrammar = null;
// constructors
public XSAnnotationImpl(String contents, SchemaGrammar grammar) {
fData = contents;
fGrammar = grammar;
}
/**
* Write contents of the annotation to the specified DOM object. If the
* specified target
object is a DOM in-scope namespace
* declarations for annotation
element are added as
* attributes nodes of the serialized annotation
, otherwise
* the corresponding events for all in-scope namespace declaration are
* sent via specified document handler.
* @param target A target pointer to the annotation target object, i.e.
* org.w3c.dom.Document
,
* org.xml.sax.ContentHandler
.
* @param targetType A target type.
* @return If the target
is recognized type and supported by
* this implementation return true, otherwise return false.
*/
public boolean writeAnnotation(Object target,
short targetType) {
if(targetType == XSAnnotation.W3C_DOM_ELEMENT || targetType == XSAnnotation.W3C_DOM_DOCUMENT) {
writeToDOM((Node)target, targetType);
return true;
} else if (targetType == SAX_CONTENTHANDLER) {
writeToSAX((ContentHandler)target);
return true;
}
return false;
}
/**
* A text representation of annotation.
*/
public String getAnnotationString() {
return fData;
}
// XSObject methods
/**
* The type
of this object, i.e.
* ELEMENT_DECLARATION
.
*/
public short getType() {
return XSConstants.ANNOTATION;
}
/**
* The name of type NCName
of this declaration as defined in
* XML Namespaces.
*/
public String getName() {
return null;
}
/**
* The [target namespace] of this object, or null
if it is
* unspecified.
*/
public String getNamespace() {
return null;
}
/**
* A namespace schema information item corresponding to the target
* namespace of the component, if it's globally declared; or null
* otherwise.
*/
public XSNamespaceItem getNamespaceItem() {
return null;
}
// private methods
private synchronized void writeToSAX(ContentHandler handler) {
// nothing must go wrong with this parse...
SAXParser parser = fGrammar.getSAXParser();
StringReader aReader = new StringReader(fData);
InputSource aSource = new InputSource(aReader);
parser.setContentHandler(handler);
try {
parser.parse(aSource);
}
catch (SAXException e) {
// this should never happen!
// REVISIT: what to do with this?; should really not
// eat it...
}
catch (IOException i) {
// ditto with above
}
// Release the reference to the user's ContentHandler.
parser.setContentHandler(null);
}
// this creates the new Annotation element as the first child
// of the Node
private synchronized void writeToDOM(Node target, short type) {
Document futureOwner = (type == XSAnnotation.W3C_DOM_ELEMENT) ?
target.getOwnerDocument() : (Document)target;
DOMParser parser = fGrammar.getDOMParser();
StringReader aReader = new StringReader(fData);
InputSource aSource = new InputSource(aReader);
try {
parser.parse(aSource);
}
catch (SAXException e) {
// this should never happen!
// REVISIT: what to do with this?; should really not
// eat it...
}
catch (IOException i) {
// ditto with above
}
Document aDocument = parser.getDocument();
parser.dropDocumentReferences();
Element annotation = aDocument.getDocumentElement();
Node newElem = null;
if (futureOwner instanceof CoreDocumentImpl) {
newElem = futureOwner.adoptNode(annotation);
// adoptNode will return null when the DOM implementations are not compatible.
if (newElem == null) {
newElem = futureOwner.importNode(annotation, true);
}
}
else {
newElem = futureOwner.importNode(annotation, true);
}
target.insertBefore(newElem, target.getFirstChild());
}
}