19f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 29f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Licensed to the Apache Software Foundation (ASF) under one 39f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * or more contributor license agreements. See the NOTICE file 49f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed with this work for additional information 59f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * regarding copyright ownership. The ASF licenses this file 69f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * to you under the Apache License, Version 2.0 (the "License"); 79f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * you may not use this file except in compliance with the License. 89f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * You may obtain a copy of the License at 99f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 109f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 119f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 129f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Unless required by applicable law or agreed to in writing, software 139f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 149f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 159f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * See the License for the specific language governing permissions and 169f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * limitations under the License. 179f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 189f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/* 199f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * $Id: ElemComment.java 468643 2006-10-28 06:56:03Z minchau $ 209f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 219f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpackage org.apache.xalan.templates; 229f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 239f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport javax.xml.transform.TransformerException; 249f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 259f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.apache.xalan.res.XSLTErrorResources; 269f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonimport org.apache.xalan.transformer.TransformerImpl; 279f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 289f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson/** 299f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Implement xsl:comment. 309f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * <pre> 319f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * <!ELEMENT xsl:comment %char-template;> 329f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * <!ATTLIST xsl:comment %space-att;> 339f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * </pre> 349f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @see <a href="http://www.w3.org/TR/xslt#section-Creating-Comments">section-Creating-Comments in XSLT Specification</a> 359f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @xsl.usage advanced 369f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 379f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilsonpublic class ElemComment extends ElemTemplateElement 389f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson{ 399f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson static final long serialVersionUID = -8813199122875770142L; 409f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 419f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 429f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Get an int constant identifying the type of element. 439f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @see org.apache.xalan.templates.Constants 449f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 459f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return The token ID for this element 469f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 479f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public int getXSLToken() 489f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 499f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return Constants.ELEMNAME_COMMENT; 509f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 519f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 529f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 539f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Return the node name. 549f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 559f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return This element's name 569f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 579f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public String getNodeName() 589f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 599f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return Constants.ELEMNAME_COMMENT_STRING; 609f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 619f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 629f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 639f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Execute the xsl:comment transformation 649f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 659f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 669f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @param transformer non-null reference to the the current transform-time state. 679f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 689f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @throws TransformerException 699f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 709f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public void execute( 719f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson TransformerImpl transformer) 729f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson throws TransformerException 739f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 749f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson try 759f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 769f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // Note the content model is: 779f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // <!ENTITY % instructions " 789f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // %char-instructions; 799f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // | xsl:processing-instruction 809f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // | xsl:comment 819f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // | xsl:element 829f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // | xsl:attribute 839f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // "> 849f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson String data = transformer.transformToString(this); 859f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 869f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson transformer.getResultTreeHandler().comment(data); 879f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 889f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson catch(org.xml.sax.SAXException se) 899f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 909f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson throw new TransformerException(se); 919f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 929f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 939f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 949f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson /** 959f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * Add a child to the child list. 969f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 979f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @param newChild Child to add to this node's child list 989f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 999f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @return Child that was just added to child list 1009f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * 1019f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson * @throws DOMException 1029f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson */ 1039f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson public ElemTemplateElement appendChild(ElemTemplateElement newChild) 1049f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1059f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1069f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson int type = ((ElemTemplateElement) newChild).getXSLToken(); 1079f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1089f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson switch (type) 1099f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson { 1109f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1119f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // char-instructions 1129f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_TEXTLITERALRESULT : 1139f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_APPLY_TEMPLATES : 1149f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_APPLY_IMPORTS : 1159f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_CALLTEMPLATE : 1169f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_FOREACH : 1179f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_VALUEOF : 1189f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_COPY_OF : 1199f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_NUMBER : 1209f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_CHOOSE : 1219f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_IF : 1229f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_TEXT : 1239f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_COPY : 1249f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_VARIABLE : 1259f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson case Constants.ELEMNAME_MESSAGE : 1269f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1279f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // instructions 1289f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // case Constants.ELEMNAME_PI: 1299f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // case Constants.ELEMNAME_COMMENT: 1309f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // case Constants.ELEMNAME_ELEMENT: 1319f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson // case Constants.ELEMNAME_ATTRIBUTE: 1329f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson break; 1339f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson default : 1349f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson error(XSLTErrorResources.ER_CANNOT_ADD, 1359f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson new Object[]{ newChild.getNodeName(), 1369f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson this.getNodeName() }); //"Can not add " +((ElemTemplateElement)newChild).m_elemName + 1379f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1389f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson //" to " + this.m_elemName); 1399f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1409f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson 1419f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson return super.appendChild(newChild); 1429f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson } 1439f8118474e9513f7a5b7d2a05e4a0fb15d1a6569Jesse Wilson} 144