bundles/org.eclipse.wst.xsl.core/src_validation/org/eclipse/wst/xsl/core/internal/compiler/xslt10/templates/ElemMessage.java

/*******************************************************************************
 * Copyright (c) 2008 Standards for Technology in Automotive Retail
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     David Carver - STAR - bug 224197 - initial API and implementation
 *                    based on work from Apache Xalan 2.7.0
 *******************************************************************************/
/*
 * Copyright 1999-2004 The Apache Software Foundation.
 *
 * Licensed 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.
 */
/*
 * $Id: ElemMessage.java,v 1.3 2008/03/28 02:38:15 dacarver Exp $
 */
package org.eclipse.wst.xsl.core.internal.compiler.xslt10.templates;

import javax.xml.transform.TransformerException;

import org.eclipse.wst.xsl.core.compiler.xslt10.res.Messages;
import org.eclipse.wst.xsl.core.compiler.xslt10.res.XSLTErrorResources;
import org.eclipse.wst.xsl.core.internal.compiler.xslt10.transformer.TransformerImpl;

/**
 * Implement xsl:message.
 * 
 * <pre>
 * &lt;!ELEMENT xsl:message %template;&gt;
 * &lt;!ATTLIST xsl:message
 *   %space-att;
 *   terminate (yes|no) &quot;no&quot;
 * &gt;
 * </pre>
 * 
 * @see <a href="http://www.w3.org/TR/xslt#message">message in XSLT
 *      Specification</a>
 * @xsl.usage advanced
 */
public class ElemMessage extends ElemTemplateElement {
	static final long serialVersionUID = 1530472462155060023L;

	/**
	 * If the terminate attribute has the value yes, then the XSLT transformer
	 * should terminate processing after sending the message. The default value
	 * is no.
	 * 
	 * @serial
	 */
	private boolean m_terminate = Constants.ATTRVAL_NO; // default value

	/**
	 * Set the "terminate" attribute. If the terminate attribute has the value
	 * yes, then the XSLT transformer should terminate processing after sending
	 * the message. The default value is no.
	 * 
	 * @param v
	 *            Value to set for "terminate" attribute.
	 */
	public void setTerminate(boolean v) {
		m_terminate = v;
	}

	/**
	 * Get the "terminate" attribute. If the terminate attribute has the value
	 * yes, then the XSLT transformer should terminate processing after sending
	 * the message. The default value is no.
	 * 
	 * @return value of "terminate" attribute.
	 */
	public boolean getTerminate() {
		return m_terminate;
	}

	/**
	 * Get an int constant identifying the type of element.
	 * 
	 * @see org.apache.xalan.templates.Constants
	 * 
	 * @return The token ID for this element
	 */
	@Override
	public int getXSLToken() {
		return Constants.ELEMNAME_MESSAGE;
	}

	/**
	 * Return the node name.
	 * 
	 * @return name of the element
	 */
	@Override
	public String getNodeName() {
		return Constants.ELEMNAME_MESSAGE_STRING;
	}

	/**
	 * Send a message to diagnostics. The xsl:message instruction sends a
	 * message in a way that is dependent on the XSLT transformer. The content
	 * of the xsl:message instruction is a template. The xsl:message is
	 * instantiated by instantiating the content to create an XML fragment. This
	 * XML fragment is the content of the message.
	 * 
	 * @param transformer
	 *            non-null reference to the the current transform-time state.
	 * 
	 * @throws TransformerException
	 */
	@Override
	public void execute(TransformerImpl transformer)
			throws TransformerException {

		if (transformer.getDebug())
			transformer.getTraceManager().fireTraceEvent(this);

		String data = transformer.transformToString(this);

		transformer.getMsgMgr().message(this, data, m_terminate);

		if (m_terminate)
			transformer
					.getErrorListener()
					.fatalError(
							new TransformerException(
									Messages
											.createMessage(
													XSLTErrorResources.ER_STYLESHEET_DIRECTED_TERMINATION,
													null))); // "Stylesheet
																// directed
																// termination"));

		if (transformer.getDebug())
			transformer.getTraceManager().fireTraceEndEvent(this);
	}
}