001package org.hl7.fhir.utilities.xml;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009    
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030 */
031
032
033
034import java.io.IOException;
035
036import org.hl7.fhir.utilities.ElementDecoration;
037
038
039/**
040 * Generalize 
041 * @author dennisn
042 */
043public interface IXMLWriter {
044        
045  public abstract void start() throws IOException;
046  public abstract void end() throws IOException;
047
048        public abstract void attribute(String namespace, String name, String value, boolean onlyIfNotEmpty) throws IOException;
049        public abstract void attribute(String namespace, String name, String value) throws IOException;
050        public abstract void attribute(String name, String value, boolean onlyIfNotEmpty) throws IOException;
051        public abstract void attribute(String name, String value) throws IOException;
052        public abstract void attributeNoLines(String name, String value) throws IOException;
053
054        public abstract boolean namespaceDefined(String namespace);
055        public abstract boolean abbreviationDefined(String abbreviation);
056        public abstract String getDefaultNamespace();
057        public abstract void namespace(String namespace) throws IOException;
058        public abstract void setDefaultNamespace(String namespace) throws IOException;
059        public abstract void namespace(String namespace, String abbreviation) throws IOException;
060        
061        public abstract void comment(String comment, boolean doPretty) throws IOException;
062        public abstract void decorate(ElementDecoration decoration) throws IOException;
063        public abstract void setSchemaLocation(String ns, String loc) throws IOException;
064
065  public abstract void enter(String name) throws IOException;
066        public abstract void enter(String namespace, String name) throws IOException;
067        public abstract void enter(String namespace, String name, String comment) throws IOException;
068        
069  public abstract void exit() throws IOException;
070        public abstract void exit(String name) throws IOException;
071        public abstract void exit(String namespace, String name) throws IOException;
072        public abstract void exitToLevel(int count) throws IOException;
073
074
075        public abstract void element(String namespace, String name, String content,     boolean onlyIfNotEmpty) throws IOException;
076        public abstract void element(String namespace, String name, String content,     String comment) throws IOException;
077        public abstract void element(String namespace, String name, String content)     throws IOException;
078        public abstract void element(String name, String content,       boolean onlyIfNotEmpty) throws IOException;
079        public abstract void element(String name, String content)       throws IOException;
080        public abstract void element(String name) throws IOException;
081
082        public abstract void text(String content) throws IOException;
083        public abstract void text(String content, boolean dontEscape) throws IOException;
084
085        public abstract void cData(String text) throws IOException;
086
087        public abstract void writeBytes(byte[] bytes) throws IOException;
088
089        public abstract boolean isPretty() throws IOException;
090        public abstract void setPretty(boolean pretty) throws IOException;
091
092        /**
093         * Start comment inserts a <!-- in the stream, but allows the user to 
094         * go on creating xml content as usual, with proper formatting applied etc.
095         * Any comments inserted inside a comment will be terminated with -- > instead of -->
096         * so the comment doesn't close prematurely.
097         * @throws IOException 
098         */
099        public abstract void startCommentBlock() throws IOException;
100        public abstract void endCommentBlock() throws IOException;
101        public abstract void escapedText(String content) throws IOException;
102        
103        // this is only implemented by an implementation that is producing an xhtml representation, and is able to render elements as hyperlinks 
104  public abstract void link(String href);
105  public abstract void anchor(String name);
106}