/*
* JBoss, Home of Professional Open Source.
* See the COPYRIGHT.txt file distributed with this work for information
* regarding copyright ownership. Some portions may be licensed
* to Red Hat, Inc. under one or more contributor license agreements.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*/
package org.teiid.query.processor.xml;
import static org.teiid.query.analysis.AnalysisRecord.*;
import org.teiid.client.plan.PlanNode;
import org.teiid.common.buffer.BlockedException;
import org.teiid.core.TeiidComponentException;
import org.teiid.core.TeiidProcessingException;
import org.teiid.logging.LogConstants;
import org.teiid.logging.LogManager;
/**
* Adds a comment to an element of the document in progress
*/
public class AddCommentInstruction extends ProcessorInstruction {
private String commentText;
/**
* Constructor
* @param commentText text of the comment
*/
public AddCommentInstruction(String commentText) {
this.commentText = commentText;
}
/**
* outputs comment for an XML element (comment node is actually
* child of XML element node)
* @see ProcessorInstruction#process(ProcessorEnvironment)
*/
public XMLContext process(XMLProcessorEnvironment env, XMLContext context)
throws BlockedException, TeiidComponentException, TeiidProcessingException{
DocumentInProgress doc = env.getDocumentInProgress();
doc.addComment(this.commentText);
LogManager.logTrace(LogConstants.CTX_XML_PLAN, "COMMENT"); //$NON-NLS-1$
env.incrementCurrentProgramCounter();
return context;
}
public String toString() {
StringBuffer str = new StringBuffer();
str.append("COMMENT"); //$NON-NLS-1$
return str.toString();
}
public PlanNode getDescriptionProperties() {
PlanNode props = new PlanNode("COMMENT"); //$NON-NLS-1$
props.addProperty(PROP_MESSAGE, this.commentText);
return props;
}
}