1 /* 2 * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.tools.internal.xjc.reader.internalizer; 27 28 import org.w3c.dom.Element; 29 import org.xml.sax.helpers.XMLFilterImpl; 30 31 /** 32 * Encapsulates schema-language dependent internalization logic. 33 * 34 * {@link Internalizer} and {@link DOMForest} are responsible for 35 * doing schema language independent part, and this object is responsible 36 * for schema language dependent part. 37 * 38 * @author 39 * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) 40 */ 41 public interface InternalizationLogic { 42 /** 43 * Creates a new instance of XMLFilter that can be used to 44 * find references to external schemas. 45 * 46 * <p> 47 * Schemas that are included/imported need to be a part of 48 * {@link DOMForest}, and this filter will be expected to 49 * find such references. 50 * 51 * <p> 52 * Once such a reference is found, the filter is expected to 53 * call the parse method of DOMForest. 54 * 55 * <p> 56 * {@link DOMForest} will register ErrorHandler to the returned 57 * object, so any error should be sent to that error handler. 58 * 59 * @return 60 * This method returns {@link XMLFilterImpl} because 61 * the filter has to be usable for two directions 62 * (wrapping a reader and wrapping a ContentHandler) 63 */ 64 XMLFilterImpl createExternalReferenceFinder( DOMForest parent ); 65 66 /** 67 * Checks if the specified element is a valid target node 68 * to attach a customization. 69 * 70 * @param parent 71 * The owner DOMForest object. Probably useful only 72 * to obtain context information, such as error handler. 73 * @param bindings 74 * {@code <jaxb:bindings>} element or a customization element. 75 * @return 76 * true if it's OK, false if not. 77 */ 78 boolean checkIfValidTargetNode( DOMForest parent, Element bindings, Element target ); 79 80 /** 81 * Prepares an element that actually receives customizations. 82 * 83 * <p> 84 * For example, in XML Schema, target nodes can be any schema 85 * element but it is always the {@code <xsd:appinfo>} element that 86 * receives customization. 87 * 88 * @param target 89 * The target node designated by the customization. 90 * @return 91 * Always return non-null valid object 92 */ 93 Element refineTarget( Element target ); 94 }