org.smooks.cartridges.javabean.dynamic.BeanMetadata 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.dynamic;
import org.smooks.api.delivery.fragment.Fragment;
import org.smooks.assertion.AssertArgument;
import org.smooks.cartridges.javabean.dynamic.serialize.BeanWriter;
import org.smooks.cartridges.javabean.dynamic.serialize.DefaultNamespace;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* Bean metadata.
*
* This class is used to hold additional data about a model bean instance.
*
* @author [email protected]
*/
public class BeanMetadata {
protected Object bean;
protected String namespace;
protected String namespacePrefix;
protected Fragment createSource;
protected List populateSources = new ArrayList<>();
protected String preText;
protected Map properties;
protected BeanWriter writer;
/**
* Public constructor.
*
* @param bean The bean instance.
*/
public BeanMetadata(Object bean) {
AssertArgument.isNotNull(bean, "bean");
this.bean = bean;
}
/**
* Get the bean instance with which this metadata instance is associated.
*
* @return The bean instance.
*/
public Object getBean() {
return bean;
}
/**
* Get the XML namespace with which the associated bean instance is associated.
*
* @return The XML namespace with which the bean instance is associated.
* @see #setNamespace(String)
* @see #setNamespacePrefix(String)
* @see #getNamespacePrefix()
*/
public String getNamespace() {
return namespace;
}
/**
* Set the XML namespace with which the associated bean instance is associated.
*
* If the bean instance was created from a source XML message, the namespace will
* be set from the namespace of the source XML. If the bean instance was created and
* {@link Model#registerBean(Object) registered manually on the Model}, the
* {@link DefaultNamespace default namepsace} is
* set (can be reset).
*
* @param namespace The XML namespace with which the bean instance is associated.
* @return this BeanMetadata instance.
* @see #getNamespace()
* @see #setNamespacePrefix(String)
* @see #getNamespacePrefix()
*/
public BeanMetadata setNamespace(String namespace) {
this.namespace = namespace;
return this;
}
/**
* Get the XML namespace prefix.
*
* @return The XML namespace prefix.
* @see #setNamespace(String)
* @see #getNamespace()
* @see #setNamespacePrefix(String)
*/
public String getNamespacePrefix() {
return namespacePrefix;
}
/**
* Set the XML namespace prefix.
*
* If the bean instance was created from a source XML message, the prefix will
* be set from the prefix of the source XML. If the bean instance was created and
* {@link Model#registerBean(Object) registered manually on the Model}, the
* {@link DefaultNamespace default namepsace prefix} is
* set (can be reset).
*
* @param namespacePrefix The XML namespace prefix.
* @return this BeanMetadata instance.
* @see #setNamespace(String)
* @see #getNamespace()
* @see #getNamespacePrefix()
*/
public BeanMetadata setNamespacePrefix(String namespacePrefix) {
this.namespacePrefix = namespacePrefix;
return this;
}
/**
* Get the "pre text" associated with the bean.
*
* When a {@link ModelBuilder#readModel(java.io.Reader, Class) Model is created/read from a source XML message},
* the different fragments in the source message are responsible for triggering creation of beans that go into
* the {@link Model} instance. The "pre text" of a bean is the XML whitespace, comments, CDATA and non contributing
* XML that precedes the XML fragment that created the bean. This is an ad-hoc mechanism for maintaining user comments
* etc.
*
* @return The "pre text".
*/
public String getPreText() {
return preText;
}
/**
* Set the "pre text" associated with the bean.
*
* When a {@link ModelBuilder#readModel(java.io.Reader, Class) Model is created/read from a source XML message},
* the different fragments in the source message are responsible for triggering creation of beans that go into
* the {@link Model} instance. The "pre text" of a bean is the XML whitespace, comments, CDATA and non contributing
* XML that precedes the XML fragment that created the bean. This is an ad-hoc mechanism for maintaining user comments
* etc.
*
* @param preText The "pre text".
* @return this BeanMetadata instance.
*/
public BeanMetadata setPreText(String preText) {
this.preText = preText;
return this;
}
/**
* Get the {@link BeanWriter} instance to be used to serialize the bean instance.
*
* @return The {@link BeanWriter} instance to be used to serialize the bean instance, or null if
* no {@link BeanWriter} instance is configured for the bean type and namespace combination.
*/
public BeanWriter getWriter() {
return writer;
}
/**
* Set the {@link BeanWriter} instance to be used to serialize the bean instance.
*
* @param writer The {@link BeanWriter} instance to be used to serialize the bean instance.
* @return this BeanMetadata instance.
*/
public BeanMetadata setWriter(BeanWriter writer) {
this.writer = writer;
return this;
}
/**
* Set the source {@link Fragment} that created the bean instance.
*
* @param createSource The source fragment.
* @return this BeanMetadata instance.
*/
public BeanMetadata setCreateSource(Fragment createSource) {
this.createSource = createSource;
return this;
}
/**
* Get the source {@link Fragment} that created the bean instance.
*
* @return The source fragment, or null if the bean was not created from a source fragment
* (may have been manually constructed and added to the model).
*/
public Fragment getCreateSource() {
return createSource;
}
/**
* Get the "population" {@link Fragment fragments} that contributed data to the bean instance
* (set data on it's properties).
*
* @return The list of "population" fragments. An empty List is returned if no "population"
* fragments were recorded.
*/
public List getPopulateSources() {
return populateSources;
}
/**
* Get user properties/metadata associated with the bean.
*
* A mechanism for associating additional "user defined" metadata.
*
* @return The user properties/metadata associated with the bean.
*/
public Map getProperties() {
if (properties == null) {
properties = new LinkedHashMap();
}
return properties;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy