org.smooks.cartridges.javabean.Value Maven / Gradle / Ivy
The newest version!
/*-
* ========================LICENSE_START=================================
* smooks-javabean-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.javabean;
import org.smooks.api.Registry;
import org.smooks.api.converter.TypeConverter;
import org.smooks.api.converter.TypeConverterFactory;
import org.smooks.api.delivery.ContentHandlerBinding;
import org.smooks.api.resource.config.ResourceConfig;
import org.smooks.api.resource.visitor.Visitor;
import org.smooks.assertion.AssertArgument;
import org.smooks.cartridges.javabean.ext.SelectorPropertyResolver;
import org.smooks.engine.converter.TypeConverterFactoryLoader;
import org.smooks.engine.delivery.DefaultContentHandlerBinding;
import org.smooks.engine.lookup.converter.SourceTargetTypeConverterFactoryLookup;
import org.smooks.engine.resource.config.DefaultResourceConfig;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.Set;
/**
* Programmatic Value Configurator.
*
* This class can be used to programmatically configure a Smooks instance for creating value
* objects using the Smooks DataDecoders.
*
* This class uses a Fluent API (all methods return the Bean instance), making it easy to
* string configurations together.
*
* Example
* Taking the "classic" Order message as an example and getting the order number and
* name as Value Objects in the form of an Integer and String.
* The Message
*
* <order xmlns="http://x">
* <header>
* <y:date xmlns:y="http://y">Wed Nov 15 13:45:28 EST 2006</y:date>
* <customer number="123123">Joe</customer>
* <privatePerson></privatePerson>
* </header>
* <order-items>
* <!-- .... --!>
* </order-items>
* </order>
*
*
* The Binding Configuration and Execution Code
* The configuration code (Note: Smooks instance defined and instantiated globally):
*
* Smooks smooks = new Smooks();
*
* Value customerNumberValue = new Value( "customerNumber", "customer/@number")
* .setDecoder("Integer");
* Value customerNameValue = new Value( "customerName", "customer")
* .setDefault("Unknown");
*
* smooks.addVisitors(customerNumberValue);
* smooks.addVisitors(customerNameValue);
*
*
* And the execution code:
*
* JavaResult result = new JavaResult();
*
* smooks.filterSource(new StreamSource(orderMessageStream), result);
* Integer customerNumber = (Integer) result.getBean("customerNumber");
* String customerName = (String) result.getBean("customerName");
*
*
* @author [email protected]
* @see Bean
*/
public class Value extends BindingAppender {
protected static volatile Set> TYPE_CONVERTER_FACTORIES;
protected final Registry registry;
protected final String dataSelector;
protected String defaultValue;
protected TypeConverter typeConverter;
/**
* Create a Value binding configuration.
*
* @param beanId The bean id under which the value will be stored.
* @param data The data selector for the data value to be bound.
*/
public Value(String beanId, String data, Registry registry) {
super(beanId);
AssertArgument.isNotNullAndNotEmpty(beanId, "beanId");
AssertArgument.isNotNullAndNotEmpty(data, "dataSelector");
if (TYPE_CONVERTER_FACTORIES == null) {
synchronized (Value.class) {
if (TYPE_CONVERTER_FACTORIES == null) {
TYPE_CONVERTER_FACTORIES = new TypeConverterFactoryLoader().load(registry.getClassLoader());
}
}
}
this.dataSelector = data;
this.registry = registry;
}
/**
* Create a Value binding configuration.
*
* @param beanId The bean id under which the value will be stored.
* @param data The data selector for the data value to be bound.
* @param type Data type.
*/
public Value(String beanId, String data, Class type, Registry registry) {
this(beanId, data, registry);
AssertArgument.isNotNull(type, "type");
this.typeConverter = new SourceTargetTypeConverterFactoryLookup<>(String.class, type).lookup(TYPE_CONVERTER_FACTORIES).createTypeConverter();
}
/**
* The default value for if the data is null or empty
*
* @param defaultValue The default value
* @return this Value configuration instance.
*/
public Value setDefaultValue(String defaultValue) {
this.defaultValue = defaultValue;
return this;
}
/**
* Set the binding value data type.
*
* @param type The data type.
* @return this Value configuration instance.
*/
public Value setType(Class type) {
this.typeConverter = new SourceTargetTypeConverterFactoryLookup<>(String.class, type).lookup(TYPE_CONVERTER_FACTORIES).createTypeConverter();
return this;
}
/**
* The {@link org.smooks.cartridges.javabean.DataDecoder} to be used for decoding
* the data value.
*
* @param targetNamespace The {@link org.smooks.cartridges.javabean.DataDecoder}
* @return this Value configuration instance.
*/
public Value setTypeConverter(TypeConverter typeConverter) {
this.typeConverter = typeConverter;
return this;
}
/**
* Used by Smooks to retrieve the visitor configuration of this Value Configuration
*/
@Override
public List> addVisitors() {
List> visitorBindings = new ArrayList<>();
ValueBinder valueBinder = new ValueBinder(getBeanId());
ResourceConfig valueBinderSmooksResourceConfiguration = new DefaultResourceConfig(dataSelector, new Properties());
SelectorPropertyResolver.resolveSelectorTokens(valueBinderSmooksResourceConfiguration);
valueBinder.setTypeConverter(typeConverter);
valueBinder.setDefaultValue(defaultValue);
valueBinder.setValueAttributeName(valueBinderSmooksResourceConfiguration.getParameterValue(BeanInstancePopulator.VALUE_ATTRIBUTE_NAME, String.class));
visitorBindings.add(new DefaultContentHandlerBinding<>(valueBinder, valueBinderSmooksResourceConfiguration.getSelectorPath().getSelector(), registry));
return visitorBindings;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy