001/*
002Copyright (c) 2011+, HL7, Inc
003All rights reserved.
004
005Redistribution and use in source and binary forms, with or without modification, 
006are permitted provided that the following conditions are met:
007
008 * Redistributions of source code must retain the above copyright notice, this 
009   list of conditions and the following disclaimer.
010 * Redistributions in binary form must reproduce the above copyright notice, 
011   this list of conditions and the following disclaimer in the documentation 
012   and/or other materials provided with the distribution.
013 * Neither the name of HL7 nor the names of its contributors may be used to 
014   endorse or promote products derived from this software without specific 
015   prior written permission.
016
017THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
018ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
019WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
020IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
021INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
022NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
023PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
024WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
025ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
026POSSIBILITY OF SUCH DAMAGE.
027
028*/
029package org.hl7.fhir.utilities.xml;
030
031import org.hl7.fhir.utilities.Utilities;
032import org.hl7.fhir.utilities.xml.XhtmlGeneratorAdorner.XhtmlGeneratorAdornerState;
033import org.w3c.dom.Element;
034
035public interface XhtmlGeneratorAdorner {
036
037  public class XhtmlGeneratorAdornerState {
038    private String prefix;
039    private String suffix;
040    private String supressionMessage;
041    private String path;
042    
043    public XhtmlGeneratorAdornerState(String path, String prefix, String suffix) {
044      super();
045      this.path = path;
046      this.prefix = prefix;
047      this.suffix = suffix;
048    }
049    
050    public XhtmlGeneratorAdornerState(String path, String supressionMessage) {
051      super();
052      this.path = path;
053      this.supressionMessage = supressionMessage;
054    }
055
056    public String getPrefix() {
057      return prefix;
058    }
059    public String getSuffix() {
060      return suffix;
061    }
062    public boolean isSuppress() {
063      return !Utilities.noString(supressionMessage);
064    }
065    public String getSupressionMessage() {
066      return supressionMessage;
067    }
068    public String getPath() {
069      return path;
070    }
071  }
072  
073  XhtmlGeneratorAdornerState getState(XhtmlGenerator ref, XhtmlGeneratorAdornerState state, Element node) throws Exception;
074  XhtmlGeneratorAdornerState getAttributeMarkup(XhtmlGenerator xhtmlGenerator, XhtmlGeneratorAdornerState state, Element node, String nodeName, String textContent) throws Exception;
075  String getLink(XhtmlGenerator ref, XhtmlGeneratorAdornerState state, Element node) throws Exception;
076  String getNodeId(XhtmlGeneratorAdornerState state, Element node);
077
078}
079