org.smooks.cartridges.cdres.trans.SetAttributeTU Maven / Gradle / Ivy

Go to download
/*-
 * ========================LICENSE_START=================================
 * smooks-misc-cartridge
 * %%
 * Copyright (C) 2020 Smooks
 * %%
 * Licensed under the terms of the Apache License Version 2.0, or
 * the GNU Lesser General Public License version 3.0 or later.
 * 
 * SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-or-later
 * 
 * ======================================================================
 * 
 * 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.
 * 
 * ======================================================================
 * 
 * This program 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 3 of the License, or (at your option) any later version.
 * 
 * This program 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 program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * =========================LICENSE_END==================================
 */
package org.smooks.cartridges.cdres.trans;

import org.smooks.api.ExecutionContext;
import org.smooks.api.resource.visitor.dom.DOMElementVisitor;
import org.w3c.dom.Element;

import javax.inject.Inject;

/**
 * Set a DOM element attribute during the processing phase.
 * .cdrl Configuration
 *  * <smooks-resource	useragent="device/profile" selector="target-element-name" 
 * 	path="org.smooks.cdres.trans.SetAttributeTU">
 * 
 * 	<!-- The name of the element attribute to be set. -->
 * 	<param name="attributeName">attribute-name</param>
 * 
 * 	<!-- The value of the element attribute to be set. -->
 * 	<param name="attributeValue">attribute-value</param>
 * 
 * 	<!-- (Optional) Overwrite existing attributes of the same name. Default false. -->
 * 	<param name="overwrite">true/false</param>
 * 
 * 	<!-- (Optional) Visit the target element before iterating over the elements
 * 		child content. Default false. -->
 * 	<param name="visitBefore">true/false</param>
 * </smooks-resource>
 * See {@link org.smooks.api.resource.config.ResourceConfig}.
 * @author tfennelly
 */
public class SetAttributeTU implements DOMElementVisitor {

    @Inject
	private String attributeName;

    @Inject
	private String attributeValue;

    @Inject
	private Boolean visitBefore = false;

    @Inject
	private Boolean overwrite = false;

    public void visitBefore(Element element, ExecutionContext executionContext) {
        if(visitBefore) {
            visit(element, executionContext);
        }
    }

    public void visitAfter(Element element, ExecutionContext executionContext) {
        if(!visitBefore) {
            visit(element, executionContext);
        }
    }

    private void visit(Element element, ExecutionContext executionContext) {
		// If the element already has the new attribute and we're
		// not overwriting, leave all as is and return.
		if(!overwrite && element.hasAttribute(attributeName)) {
			return;
		}
		element.setAttribute(attributeName, attributeValue);
	}
}