org.beanio.config.StreamDefinitionFactory Maven / Gradle / Ivy
/*
* Copyright 2010-2011 Kevin Seim
*
* 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.
*/
package org.beanio.config;
import java.beans.*;
import java.lang.reflect.*;
import java.util.*;
import java.util.regex.PatternSyntaxException;
import org.beanio.BeanIOConfigurationException;
import org.beanio.parser.*;
import org.beanio.stream.*;
import org.beanio.types.*;
import org.beanio.util.*;
/**
* A StreamDefinitionFactory is used to convert a stream configuration into a
* StreamDefinition for parsing an I/O stream.
*
* @author Kevin Seim
* @since 1.0
*/
public abstract class StreamDefinitionFactory {
private TypeHandlerFactory typeHandlerFactory;
private boolean readEnabled = true;
private boolean writeEnabled = true;
/**
* Constructs a new StreamDefinitionFactory.
*/
public StreamDefinitionFactory() { }
/**
* Creates a new stream definition based on a stream configuration.
* @param config the stream configuration
* @return the new StreamDefinition
* @throws BeanIOConfigurationException if the configuration is invalid
*/
public StreamDefinition createStreamDefinition(StreamConfig config) throws BeanIOConfigurationException {
if (config.getName() == null) {
throw new BeanIOConfigurationException("stream name not configured");
}
try {
StreamDefinition definition = newStreamDefinition(config);
compileStreamDefinition(config, definition);
return definition;
}
catch (BeanIOConfigurationException ex) {
throw new BeanIOConfigurationException("Invalid '" + config.getName() +
"' stream configuration: " + ex.getMessage(), ex);
}
}
/**
* Compiles a stream definition from its configuration.
* @param config the stream configuration
* @param definition the stream definition to compile
* @throws BeanIOConfigurationException if the configuration is invalid
*/
protected void compileStreamDefinition(StreamConfig config, StreamDefinition definition)
throws BeanIOConfigurationException {
// set the stream mode, defaults to read/write, the stream mode may be used
// to enforce or relax validation rules specific to marshalling or unmarshalling
String mode = config.getMode();
if (mode == null || StreamConfig.READ_WRITE_MODE.equals(mode)) {
definition.setMode(StreamDefinition.READ_WRITE_MODE);
}
else if (StreamConfig.READ_ONLY_MODE.equals(mode)) {
definition.setMode(StreamDefinition.READ_ONLY_MODE);
writeEnabled = false;
}
else if (StreamConfig.WRITE_ONLY_MODE.equals(mode)) {
definition.setMode(StreamDefinition.WRITE_ONLY_MODE);
readEnabled = false;
}
else {
throw new BeanIOConfigurationException("Invalid mode '" + mode + "'");
}
definition.setName(config.getName());
definition.setMinOccurs(config.getRootGroupConfig().getMinOccurs());
definition.setMaxOccurs(config.getRootGroupConfig().getMaxOccurs());
// configure the record reader factory
Bean readerFactoryBean = config.getReaderFactory();
if (readerFactoryBean != null) {
RecordReaderFactory factory;
if (readerFactoryBean.getClassName() == null) {
factory = newRecordReaderFactory();
}
else {
Object object = BeanUtil.createBean(readerFactoryBean.getClassName());
if (!RecordReaderFactory.class.isAssignableFrom(object.getClass())) {
throw new BeanIOConfigurationException("Configured reader factory class '" +
readerFactoryBean.getClassName() + "' does not implement RecordReaderFactory");
}
factory = (RecordReaderFactory) object;
}
BeanUtil.configure(factory, readerFactoryBean.getProperties());
definition.setReaderFactory(factory);
}
// configure the record writer factory
Bean writerFactoryBean = config.getWriterFactory();
if (writerFactoryBean != null) {
RecordWriterFactory factory;
if (writerFactoryBean.getClassName() == null) {
factory = newRecordWriterFactory();
}
else {
Object object = BeanUtil.createBean(writerFactoryBean.getClassName());
if (!RecordWriterFactory.class.isAssignableFrom(object.getClass())) {
throw new BeanIOConfigurationException("Configured writer factory class '" +
writerFactoryBean.getClassName() + "' does not implement RecordWriterFactory");
}
factory = (RecordWriterFactory) object;
}
BeanUtil.configure(factory, writerFactoryBean.getProperties());
definition.setWriterFactory(factory);
}
// load the stream's default resource bundle
String bundleName = Settings.getInstance().getProperty(
"org.beanio." + definition.getFormat() + ".messages");
if (bundleName != null) {
try {
definition.setDefaultResourceBundle(ResourceBundle.getBundle(bundleName));
}
catch (MissingResourceException ex) {
throw new BeanIOConfigurationException("Missing default resource bundle '" +
bundleName + "' for stream format '" + definition.getFormat() + "'", ex);
}
}
// load the stream resource bundle
bundleName = config.getResourceBundle();
if (bundleName != null) {
try {
definition.setResourceBundle(ResourceBundle.getBundle(bundleName));
}
catch (MissingResourceException ex) {
throw new BeanIOConfigurationException("Missing resource bundle '" +
bundleName + "'", ex);
}
}
updateStreamDefinition(config, definition);
updateGroupDefinition(null, config.getRootGroupConfig(), definition.getRootGroupDefinition());
compileGroupDefinition(config, config.getRootGroupConfig(), definition.getRootGroupDefinition());
}
/**
* This method is called by compileStreamDefinition to allow the configuration
* of stream specific stream configuration settings.
* @param config the stream configuration
* @param definition the stream definition
* @since 1.1
*/
protected void updateStreamDefinition(StreamConfig config, StreamDefinition definition) { }
/**
* Compiles a group definition from its configuration.
* @param streamConfig the parent stream configuration
* @param groupConfig the group configuration
* @param definition the group definition to compile
*/
protected final void compileGroupDefinition(StreamConfig streamConfig, GroupConfig groupConfig,
GroupDefinition definition) {
List nodeList = groupConfig.getChildren();
if (nodeList.isEmpty()) {
throw new BeanIOConfigurationException("At least one record or record group is required.");
}
// by default, order is incremented for each record
int lastOrder = 0;
for (NodeConfig child : nodeList) {
String nodeType = child.getType() == NodeConfig.RECORD ? "record" : "group";
int order;
if (streamConfig.isOrdered()) {
order = child.getOrder();
// defaults the order to the last order plus one
if (order < 1) {
order = lastOrder + 1;
}
// validate all nodes are in order
else if (order < lastOrder) {
throw new BeanIOConfigurationException(
"'" + child.getName() + "' " + nodeType + " configuration is out of order");
}
lastOrder = order;
}
else {
// validate node order isn't set if the stream is unordered
if (child.getOrder() >= 0) {
throw new BeanIOConfigurationException(
"Invalid '" + child.getName() + "' " + nodeType + " configuration: " +
"Order cannot be set when ordered=\"false\"");
}
order = 1;
}
NodeDefinition childDefinition;
switch (child.getType()) {
case NodeConfig.RECORD:
try {
childDefinition = newRecordDefinition((RecordConfig) child);
compileNodeDefinition(child, childDefinition, order);
compileRecordDefinition(definition, (RecordConfig) child, (RecordDefinition) childDefinition);
compileFieldDefinitions((RecordConfig) child, (RecordDefinition) childDefinition);
}
catch (BeanIOConfigurationException ex) {
throw new BeanIOConfigurationException("Invalid '" + child.getName() +
"' record configuration: " + ex.getMessage(), ex);
}
break;
case NodeConfig.GROUP:
try {
childDefinition = newGroupDefinition((GroupConfig) child);
compileNodeDefinition(child, childDefinition, order);
updateGroupDefinition(definition, (GroupConfig) child, (GroupDefinition) childDefinition);
compileGroupDefinition(streamConfig, (GroupConfig) child, (GroupDefinition) childDefinition);
}
catch (BeanIOConfigurationException ex) {
throw new BeanIOConfigurationException("Invalid '" + child.getName() +
"' group configuration: " + ex.getMessage(), ex);
}
break;
default:
throw new IllegalStateException("Invalid node type: " + child.getType());
}
definition.addChild(childDefinition);
}
}
/**
* This method is called by compileGroupDefinition to allow the configuration
* of stream specific group configuration settings.
* @param parent the parent group definition
* @param config the group configuration
* @param definition the group definition
* @since 1.1
*/
protected void updateGroupDefinition(GroupDefinition parent, GroupConfig config, GroupDefinition definition) {
}
private void compileNodeDefinition(NodeConfig config, NodeDefinition definition, int order) {
definition.setName(config.getName());
definition.setOrder(order);
int minOccurs = config.getMinOccurs() != null ? config.getMinOccurs() : 1; // default to 1
definition.setMinOccurs(minOccurs);
int maxOccurs = config.getMaxOccurs() != null ? config.getMaxOccurs() : -1; // default to unbounded
definition.setMaxOccurs(maxOccurs);
if (maxOccurs == 0) {
throw new BeanIOConfigurationException("maxOccurs must be 1 or greater");
}
if (maxOccurs > 0 && maxOccurs < minOccurs) {
throw new BeanIOConfigurationException("maxOccurs cannot be less than minOccurs");
}
}
/**
* Compiles a record definition from its configuration.
* @param config the record configuration
* @param recordDefinition the record definition
*/
protected void compileRecordDefinition(GroupDefinition group, RecordConfig config, RecordDefinition recordDefinition) {
BeanDefinition beanDefinition = newBeanDefinition(config.getBean());
beanDefinition.setName(recordDefinition.getName());
beanDefinition.setPropertyType(getBeanClass(config.getBean()));
beanDefinition.setLazy(false);
updateBeanDefinition(config.getBean(), beanDefinition);
recordDefinition.setBeanDefinition(beanDefinition);
}
/**
* Compiles a bean definition.
* @param config the bean configuration
* @param definition the bean definition to update
*/
protected void compileBeanDefinition(BeanDefinition parent, BeanConfig config, BeanDefinition definition) {
String name = config.getName();
if (name == null) {
throw new BeanIOConfigurationException("Bean name not set");
}
definition.setName(name);
definition.setParent(parent);
try {
// determine and validate the bean class
Class beanClass = getBeanClass(config);
if (beanClass == null) {
throw new BeanIOConfigurationException("Bean class not set");
}
definition.setProperty(true);
definition.setPropertyType(beanClass);
// determine the collection type
Class> collectionType = null;
if (config.getCollection() != null) {
collectionType = TypeUtil.toCollectionType(config.getCollection());
if (collectionType == null) {
throw new BeanIOConfigurationException("Invalid collection type or " +
"collection type alias '" + config.getCollection() + "'");
}
collectionType = getConcreteCollectionType(collectionType);
}
definition.setCollectionType(collectionType);
// get the property descriptor
PropertyDescriptor descriptor = null;
if (!parent.isPropertyTypeMap()) {
descriptor = getPropertyDescriptor(config, parent.getPropertyType());
if (collectionType != null) {
if (collectionType == TypeUtil.ARRAY_TYPE) {
if (!descriptor.getPropertyType().isArray()) {
throw new BeanIOConfigurationException("Collection type 'array' does not " +
"match parent bean property type '" + descriptor.getPropertyType().getName() + "'");
}
Class arrayType = descriptor.getPropertyType().getComponentType();
if (!TypeUtil.isAssignable(arrayType, beanClass)) {
throw new BeanIOConfigurationException("Configured bean array of type '" +
config.getType() + "' is not assignable to bean property " +
"array of type '" + arrayType.getName() + "'");
}
}
else {
if (!descriptor.getPropertyType().isAssignableFrom(collectionType)) {
Class beanPropertyType = descriptor.getPropertyType();
String beanPropertyTypeName;
if (beanPropertyType.isArray()) {
beanPropertyTypeName = beanPropertyType.getComponentType().getName() + "[]";
}
else {
beanPropertyTypeName = beanPropertyType.getName();
}
throw new BeanIOConfigurationException("Configured collection type '" +
config.getCollection() + "' is not assignable to bean property " +
"type '" + beanPropertyTypeName + "'");
}
}
}
else {
if (!TypeUtil.isAssignable(descriptor.getPropertyType(), beanClass)) {
throw new BeanIOConfigurationException("Configured class type '" +
config.getType() + "' is not assignable to bean property " +
"type '" + descriptor.getPropertyType().getName() + "'");
}
}
}
definition.setPropertyDescriptor(descriptor);
// validate minimum occurrences
int minOccurs = 1;
if (config.getMinOccurs() != null) {
minOccurs = config.getMinOccurs();
if (minOccurs != 1 && config.getCollection() == null && !isOptionalBeanEnabled()) {
throw new BeanIOConfigurationException(
"minOccurs must be 1, or collection type must be set");
}
}
definition.setMinOccurs(minOccurs);
// validate maximum occurrences, default is minOccurs
int maxOccurs = Math.max(minOccurs, 1);
if (config.getMaxOccurs() != null) {
maxOccurs = config.getMaxOccurs();
if (maxOccurs < 0) {
maxOccurs = -1;
}
else if (maxOccurs < minOccurs) {
throw new BeanIOConfigurationException("maxOccurs must be greater than or " +
"equal to minOccurs");
}
if (maxOccurs != 1 && config.getCollection() == null) {
throw new BeanIOConfigurationException(
"maxOccurs must be 1, or collection type must be set");
}
}
definition.setMaxOccurs(maxOccurs);
updateBeanDefinition(config, definition);
compileFieldDefinitions(config, definition);
// update the parent bean definition
parent.addProperty(definition);
if (definition.isRecordIdentifier()) {
if (parent.isCollection()) {
throw new BeanIOConfigurationException("a collection cannot contain " +
"record identifying fields");
}
parent.setRecordIdentifier(true);
}
// bean existence is typically determined by whether a property of
// this bean is found in the input stream, there are 2 exceptions:
// 1. Existence is known up front in an XML formatted stream.
// 2. If there are no non-constant properties configured for the bean and
// the bean is not a collection, existence is assumed.
boolean assumeExistence = definition.isBeanExistenceKnown();
if (!assumeExistence && !definition.isCollection()) {
assumeExistence = true;
for (PropertyDefinition property : definition.getPropertyList()) {
if (!property.isConstant()) {
assumeExistence = false;
break;
}
}
}
definition.setLazy(!assumeExistence);
}
catch (BeanIOConfigurationException ex) {
throw new BeanIOConfigurationException("Invalid '" + definition.getName() +
"' bean configuration: " + ex.getMessage(), ex);
}
}
/**
* Returns whether this stream format allows beans with zero minimum occurrences. Returns
* false by default.
* @return true if the stream format allows optional beans
* @since 1.1
*/
protected boolean isOptionalBeanEnabled() {
return false;
}
/**
* This method is called by compileBeanDefinition to allow the configuration
* of format specific bean configuration settings.
* @param beanConfig the bean configuration
* @param beanDefinition the bean definition
* @since 1.1
*/
protected void updateBeanDefinition(BeanConfig beanConfig, BeanDefinition beanDefinition) { }
/**
* Compiles child property definitions for a record. The compiled property definitions are
* added to the record definition.
* @param recordConfig the record configuration
* @param recordDefinition the record definition to update
*/
protected void compileFieldDefinitions(RecordConfig recordConfig, RecordDefinition recordDefinition) {
compileFieldDefinitions(recordConfig.getBean(), recordDefinition.getBeanDefinition());
}
/**
* Compiles child property definitions for a bean. The compiled property definitions are
* added to the bean definition.
* @param beanConfig the bean configuration
* @param beanDefinition the bean definition to update
*/
protected void compileFieldDefinitions(BeanConfig beanConfig, BeanDefinition beanDefinition) {
for (PropertyConfig property : beanConfig.getPropertyList()) {
if (property.isBean()) {
BeanConfig childBeanConfig = (BeanConfig) property;
BeanDefinition childBeanDefinition = newBeanDefinition(childBeanConfig);
compileBeanDefinition(beanDefinition, childBeanConfig, childBeanDefinition);
}
else if (property.isField()) {
FieldConfig fieldConfig = (FieldConfig) property;
FieldDefinition fieldDefinition = newFieldDefinition(fieldConfig);
compileFieldDefinition(beanDefinition, fieldConfig, fieldDefinition);
}
else { // configure a bean property
// even if the bean class is not set, we still add the property because
// other parts of the code assume the number of properties always matches
// the number of configured properties...
BeanPropertyDefinition definition = new BeanPropertyDefinition();
compileBeanPropertyDefinition(beanDefinition, (BeanPropertyConfig)property, definition);
}
}
}
/**
* Compiles a bean property definition.
* @param beanDefinition the parent bean definition
* @param config the property configuration
* @param definition the property definition
*/
protected void compileBeanPropertyDefinition(BeanDefinition beanDefinition, BeanPropertyConfig config,
BeanPropertyDefinition definition) {
if (config.getName() == null) {
throw new BeanIOConfigurationException("Missing property name");
}
try {
definition.setName(config.getName());
if (beanDefinition.getPropertyType() == null) {
definition.setProperty(false);
definition.setPropertyType(null);
beanDefinition.addProperty(definition);
return;
}
definition.setRecordIdentifier(config.isRecordIdentifier());
definition.setProperty(true);
// determine the property type
Class propertyType = null;
if (config.getType() != null) {
propertyType = TypeUtil.toType(config.getType());
if (propertyType == null) {
throw new BeanIOConfigurationException("Invalid type or type alias '" + config.getType() + "'");
}
}
// set the property descriptor on the field
PropertyDescriptor descriptor = null;
if (!beanDefinition.isPropertyTypeMap()) {
descriptor = getPropertyDescriptor(config, beanDefinition.getPropertyType());
if (propertyType == null) {
propertyType = descriptor.getPropertyType();
}
else if (!TypeUtil.isAssignable(descriptor.getPropertyType(), propertyType)) {
throw new BeanIOConfigurationException("Configured property type '" +
config.getType() + "' is not assignable to bean property " +
"type '" + descriptor.getPropertyType().getName() + "'");
}
}
definition.setPropertyDescriptor(descriptor);
// configure type handler properties
Properties typeHandlerProperties = null;
if (config.getFormat() != null) {
typeHandlerProperties = new Properties();
typeHandlerProperties.put(ConfigurableTypeHandler.FORMAT_SETTING, config.getFormat());
}
// determine the type handler based on the named handler or the field class
TypeHandler handler = null;
if (config.getTypeHandler() != null) {
handler = typeHandlerFactory.getTypeHandler(config.getTypeHandler(), typeHandlerProperties);
if (handler == null) {
throw new BeanIOConfigurationException("No configured type handler named '" +
config.getTypeHandler() + "'");
}
// if the property type was not already determine, use the type from the type handler
if (propertyType == null) {
propertyType = handler.getType();
}
// otherwise validate the property type is compatible with the type handler
else if (!TypeUtil.isAssignable(propertyType, handler.getType())) {
throw new BeanIOConfigurationException("Property type '" +
propertyType.getName() + "' is not compatible " +
"with assigned type handler named '" + config.getTypeHandler() + "'");
}
}
else {
// assume String type if the property type was not determined any other way
if (propertyType == null) {
propertyType = String.class;
}
// get a type handler for the the property type
String typeName = config.getType();
try {
if (typeName == null) {
typeName = propertyType.getName();
handler = typeHandlerFactory.getTypeHandlerFor(propertyType, typeHandlerProperties);
}
else {
handler = typeHandlerFactory.getTypeHandlerFor(typeName, typeHandlerProperties);
}
}
catch (IllegalArgumentException ex) {
throw new BeanIOConfigurationException(ex.getMessage(), ex);
}
if (handler == null) {
throw new BeanIOConfigurationException("Type handler not found for type '" + typeName + "'");
}
}
definition.setPropertyType(propertyType);
// set the property value using the configured type handler
String text = config.getValue();
if (text != null) {
try {
definition.setValue(handler.parse(text));
}
catch (TypeConversionException ex) {
throw new BeanIOConfigurationException("Type conversion failed for " +
"configured value '" + text + "': " + ex.getMessage(), ex);
}
}
}
catch (BeanIOConfigurationException ex) {
throw new BeanIOConfigurationException("Invalid '" + config.getName() +
"' property configuration: " + ex.getMessage(), ex);
}
// update the bean definition
beanDefinition.addProperty(definition);
if (definition.isRecordIdentifier()) {
if (beanDefinition.isCollection()) {
throw new BeanIOConfigurationException("a collection cannot " +
"contain record identifying fields");
}
beanDefinition.setRecordIdentifier(true);
}
}
/**
* Compiles a field definition.
* @param beanDefinition the parent bean definition
* @param field the field configuration
* @param fieldDefinition the field definition
* @since 1.2
*/
protected void compileFieldDefinition(BeanDefinition beanDefinition, FieldConfig field, FieldDefinition fieldDefinition) {
if (field.getName() == null) {
throw new BeanIOConfigurationException("Missing field name");
}
try {
fieldDefinition.setName(field.getName());
fieldDefinition.setParent(beanDefinition);
fieldDefinition.setRecordIdentifier(field.isRecordIdentifier());
fieldDefinition.setRequired(field.isRequired());
fieldDefinition.setTrim(field.isTrim());
fieldDefinition.setLiteral(field.getLiteral());
try {
fieldDefinition.setRegex(field.getRegex());
}
catch (PatternSyntaxException ex) {
throw new BeanIOConfigurationException("Invalid regex pattern", ex);
}
int minLength = field.getMinLength() != null ? field.getMinLength() : 0;
fieldDefinition.setMinLength(minLength);
int maxLength = field.getMaxLength() != null ? field.getMaxLength() : -1;
fieldDefinition.setMaxLength(maxLength);
if (maxLength > 0 && maxLength < minLength) {
throw new BeanIOConfigurationException("maxLength must be greater than or equal to minLength");
}
if (fieldDefinition.getLiteral() != null) {
int size = fieldDefinition.getLiteral().length();
if (size < minLength) {
throw new BeanIOConfigurationException("literal text length is less than minLength");
}
if (maxLength >= 0 && size > maxLength) {
throw new BeanIOConfigurationException("literal text length is greater than maxLength");
}
}
// validate minOccurs
int minOccurs = 1;
if (field.getMinOccurs() != null) {
minOccurs = field.getMinOccurs();
if (minOccurs != 1 && field.getCollection() == null && !isOptionalFieldEnabled()) {
throw new BeanIOConfigurationException(
"minOccurs must be 1, or the field collection type must be set");
}
}
fieldDefinition.setMinOccurs(minOccurs);
// validate the field's maximum occurrences, default is minOccurs
int maxOccurs = Math.max(minOccurs, 1);
if (field.getMaxOccurs() != null) {
maxOccurs = field.getMaxOccurs();
if (maxOccurs < 0) {
maxOccurs = -1;
}
else if (maxOccurs < minOccurs) {
throw new BeanIOConfigurationException("maxOccurs must be greater than or " +
"equal to minOccurs");
}
if (maxOccurs != 1 && field.getCollection() == null) {
throw new BeanIOConfigurationException(
"maxOccurs must be 1, or the field collection type must be set");
}
}
if (maxOccurs < 0 && beanDefinition.isCollection()) {
throw new BeanIOConfigurationException("Invalid maxLength, variable sized collection " +
"fields not supported for bean collections");
}
fieldDefinition.setMaxOccurs(maxOccurs);
updateFieldType(field, fieldDefinition, beanDefinition);
// set the default field value using the configured type handler
String defaultText = field.getDefault();
if (defaultText != null) {
TypeHandler handler = fieldDefinition.getTypeHandler();
if (handler != null) {
try {
fieldDefinition.setDefaultValue(handler.parse(defaultText));
}
catch (TypeConversionException ex) {
throw new BeanIOConfigurationException("Type conversion failed for " +
"configured default '" + defaultText + "': " + ex.getMessage(), ex);
}
}
else {
fieldDefinition.setDefaultValue(defaultText);
}
}
updateFieldDefinition(field, fieldDefinition);
if (fieldDefinition.isRecordIdentifier()) {
validateRecordIdentifyingCriteria(fieldDefinition);
// validate a collection is not used to identify the record
if (fieldDefinition.isCollection()) {
throw new BeanIOConfigurationException("a collection cannot be " +
"used as a record identifiers");
}
}
}
catch (BeanIOConfigurationException ex) {
throw new BeanIOConfigurationException("Invalid '" + field.getName() +
"' field configuration: " + ex.getMessage(), ex);
}
// update the bean definition
beanDefinition.addProperty(fieldDefinition);
if (fieldDefinition.isRecordIdentifier()) {
if (beanDefinition.isCollection()) {
throw new BeanIOConfigurationException("a collection cannot " +
"contain record identifying fields");
}
beanDefinition.setRecordIdentifier(true);
}
}
/**
* This method is called by compileFieldDefinitions to allow the configuration
* of format specific field configuration settings.
* @param fieldConfig the field configuration
* @param fieldDefinition the field definition
* @since 1.1
*/
protected void updateFieldDefinition(FieldConfig fieldConfig, FieldDefinition fieldDefinition) { }
/**
* This method validates a record identifying field has a literal or regular expression
* configured for identifying a record.
* @param fieldDefinition the record identifying field definition to validate
* @since 1.1
*/
protected void validateRecordIdentifyingCriteria(FieldDefinition fieldDefinition) {
// validate regex or literal is configured for record identifying fields
if (fieldDefinition.getLiteral() == null && fieldDefinition.getRegex() == null) {
throw new BeanIOConfigurationException("literal or regex pattern required " +
"for record identifying fields");
}
}
/**
* Returns whether this stream format allows fields with zero minimum occurrences. Returns
* false by default.
* @return true if the stream format allows optional fields
* @since 1.1
*/
protected boolean isOptionalFieldEnabled() {
return false;
}
/**
* Updates a field definition's property type, property descriptor and type handler
* attributes.
* @param config the field configuration
* @param fieldDefinition the field definition to update
* @param beanDefinition the record definition the field belongs to
*/
private void updateFieldType(FieldConfig config, FieldDefinition fieldDefinition,
BeanDefinition beanDefinition) {
// determine the field property type
Class propertyType = null;
if (config.getType() != null) {
propertyType = TypeUtil.toType(config.getType());
if (propertyType == null) {
throw new BeanIOConfigurationException("Invalid type or type alias '" + config.getType() + "'");
}
}
// handle ignored fields
if (config.isIgnored() || beanDefinition.getPropertyType() == null) {
fieldDefinition.setProperty(false);
fieldDefinition.setPropertyDescriptor(null);
}
else {
// update the definition to indicate the field is a bean property
fieldDefinition.setProperty(true);
// determine the field collection type
Class> collectionType = null;
if (config.getCollection() != null) {
collectionType = TypeUtil.toCollectionType(config.getCollection());
if (collectionType == null) {
throw new BeanIOConfigurationException("Invalid collection type or " +
"collection type alias '" + config.getCollection() + "'");
}
collectionType = getConcreteCollectionType(collectionType);
}
fieldDefinition.setCollectionType(collectionType);
// set the property descriptor on the field
PropertyDescriptor descriptor = null;
if (!beanDefinition.isPropertyTypeMap()) {
descriptor = getPropertyDescriptor(config, beanDefinition.getPropertyType());
if (collectionType != null) {
if (collectionType == TypeUtil.ARRAY_TYPE) {
if (!descriptor.getPropertyType().isArray()) {
throw new BeanIOConfigurationException("Collection type 'array' does not " +
"match bean property type '" + descriptor.getPropertyType().getName() + "'");
}
Class arrayType = descriptor.getPropertyType().getComponentType();
if (propertyType == null) {
propertyType = arrayType;
}
else if (!TypeUtil.isAssignable(arrayType, propertyType)) {
throw new BeanIOConfigurationException("Configured field array of type '" +
config.getType() + "' is not assignable to bean property " +
"array of type '" + arrayType.getName() + "'");
}
}
else {
if (!descriptor.getPropertyType().isAssignableFrom(collectionType)) {
Class beanPropertyType = descriptor.getPropertyType();
String beanPropertyTypeName;
if (beanPropertyType.isArray()) {
beanPropertyTypeName = beanPropertyType.getComponentType().getName() + "[]";
}
else {
beanPropertyTypeName = beanPropertyType.getName();
}
throw new BeanIOConfigurationException("Configured collection type '" +
config.getCollection() + "' is not assignable to bean property " +
"type '" + beanPropertyTypeName + "'");
}
}
}
else {
if (propertyType == null) {
propertyType = descriptor.getPropertyType();
}
else if (!TypeUtil.isAssignable(descriptor.getPropertyType(), propertyType)) {
throw new BeanIOConfigurationException("Configured field type '" +
config.getType() + "' is not assignable to bean property " +
"type '" + descriptor.getPropertyType().getName() + "'");
}
}
}
fieldDefinition.setPropertyDescriptor(descriptor);
}
// configure type handler properties
Properties typeHandlerProperties = null;
if (config.getFormat() != null) {
typeHandlerProperties = new Properties();
typeHandlerProperties.put(ConfigurableTypeHandler.FORMAT_SETTING, config.getFormat());
}
// determine the type handler based on the named handler or the field class
TypeHandler handler = null;
if (config.getTypeHandler() != null) {
handler = typeHandlerFactory.getTypeHandler(config.getTypeHandler(), typeHandlerProperties);
if (handler == null) {
throw new BeanIOConfigurationException("No configured type handler named '" +
config.getTypeHandler() + "'");
}
// if the property type was not already determine, use the type from the type handler
if (propertyType == null) {
propertyType = handler.getType();
}
// otherwise validate the property type is compatible with the type handler
else if (!TypeUtil.isAssignable(propertyType, handler.getType())) {
throw new BeanIOConfigurationException("Field property type '" +
propertyType.getName() + "' is not compatible " +
"with assigned type handler named '" + config.getTypeHandler() + "'");
}
}
else {
// assume String type if the property type was not determined any other way
if (propertyType == null) {
propertyType = String.class;
}
// get a type handler for the the property type
String typeName = config.getType();
try {
if (typeName == null) {
typeName = propertyType.getName();
handler = typeHandlerFactory.getTypeHandlerFor(propertyType, typeHandlerProperties);
}
else {
handler = typeHandlerFactory.getTypeHandlerFor(typeName, typeHandlerProperties);
}
}
catch (IllegalArgumentException ex) {
throw new BeanIOConfigurationException(ex.getMessage(), ex);
}
if (handler == null) {
throw new BeanIOConfigurationException("Type handler not found for type '" + typeName + "'");
}
}
fieldDefinition.setPropertyType(propertyType);
fieldDefinition.setTypeHandler(handler);
}
/**
* Returns the PropertyDescriptor for setting and getting the field value from
* the bean class.
* @param config the field configuration
* @param beanClass the bean class the field configuration refers to
* @return the PropertyDescriptor
*/
private PropertyDescriptor getPropertyDescriptor(PropertyConfig config, Class beanClass) {
String property = config.getName();
String setter = config.getSetter();
String getter = config.getGetter();
// calling new PropertyDescriptor(...) will throw an exception if either the getter
// or setter method is not null and not found
PropertyDescriptor descriptor = null;
try {
if (setter != null && getter != null) {
descriptor = new PropertyDescriptor(property, beanClass, getter, setter);
}
else {
// the Introspector class caches BeanInfo so subsequent calls shouldn't be a concern
BeanInfo info = Introspector.getBeanInfo(beanClass);
for (PropertyDescriptor pd : info.getPropertyDescriptors()) {
if (pd.getName().equals(property)) {
descriptor = pd;
break;
}
}
if (descriptor == null) {
if (setter == null && getter == null) {
throw new BeanIOConfigurationException("No such property '" + property +
"' in class '" + beanClass.getName() + "'");
}
else {
descriptor = new PropertyDescriptor(property, beanClass, getter, setter);
}
}
else if (setter != null) {
if (descriptor.getReadMethod() != null) {
getter = descriptor.getReadMethod().getName();
}
descriptor = new PropertyDescriptor(property, beanClass, getter, setter);
}
else if (getter != null) {
if (descriptor.getWriteMethod() != null) {
setter = descriptor.getWriteMethod().getName();
}
descriptor = new PropertyDescriptor(property, beanClass, getter, setter);
}
}
// validate a read method is found for mapping configurations that write streams
if (isReadEnabled() && descriptor.getWriteMethod() == null) {
throw new BeanIOConfigurationException("No writeable method for property '" + property +
"' in class '" + beanClass.getName() + "'");
}
// validate a write method is found for mapping configurations that read streams
if (isWriteEnabled() && descriptor.getReadMethod() == null) {
throw new BeanIOConfigurationException("No readable method for property '" + property +
"' in class '" + beanClass.getName() + "'");
}
return descriptor;
}
catch (IntrospectionException e) {
throw new BeanIOConfigurationException("Bean introspection failed: " + e.getMessage(), e);
}
}
/**
* Determines the bean class type from its configuration/
* @param config the bean configuration
* @return the bean class
*/
protected Class getBeanClass(BeanConfig config) {
// determine the bean class associated with this record
Class beanClass = null;
if (config.getType() != null) {
if ("map".equals(config.getType())) {
beanClass = HashMap.class;
}
else {
try {
beanClass = TypeUtil.loadClass(config.getType());
if (isReadEnabled() && (beanClass.isInterface() || Modifier.isAbstract(beanClass.getModifiers()))) {
throw new BeanIOConfigurationException("Class must be concrete unless " +
"stream mode is set to '" + StreamConfig.WRITE_ONLY_MODE + "'");
}
}
catch (ClassNotFoundException ex) {
throw new BeanIOConfigurationException(
"Invalid bean class '" + config.getType() + "'", ex);
}
}
}
return beanClass;
}
/**
* Returns the default concrete Collection subclass for a Collection type.
* @param collectionType the configured Collection type
* @return a concrete Collection subclass
*/
@SuppressWarnings("unchecked")
private Class> getConcreteCollectionType(
Class> collectionType) {
if (collectionType == null) {
return null;
}
else if (collectionType != TypeUtil.ARRAY_TYPE &&
(collectionType.isInterface() || Modifier.isAbstract(collectionType.getModifiers()))) {
if (Set.class.isAssignableFrom(collectionType)) {
return (Class>)(Class) HashSet.class;
}
else {
return (Class>)(Class) ArrayList.class;
}
}
else {
return collectionType;
}
}
/**
* Creates a new FieldDefinition.
* @param field the field configuration
* @return the new FieldDefinition
*/
protected abstract FieldDefinition newFieldDefinition(FieldConfig field);
/**
* Creates a new BeanDefinition.
* @param bean the bean configuration
* @return the new BeanDefinition
*/
protected abstract BeanDefinition newBeanDefinition(BeanConfig bean);
/**
* Creates a new RecordDefinition.
* @param record the record configuration
* @return the new RecordDefinition
*/
protected abstract RecordDefinition newRecordDefinition(RecordConfig record);
/**
* Creates a new GroupDefinition.
* @param group the group configuration
* @return the new GroupDefinition
*/
protected GroupDefinition newGroupDefinition(GroupConfig group) {
return new GroupDefinition();
}
/**
* Creates a new StreamDefinition.
* @param stream the stream configuration
* @return the new StreamDefinition
*/
protected abstract StreamDefinition newStreamDefinition(StreamConfig stream);
/**
* Creates a default record reader factory.
* @return the new RecordReaderFactory
*/
protected abstract RecordReaderFactory newRecordReaderFactory();
/**
* Creates a default record writer factory
* @return the new RecordWriterFactory
*/
protected abstract RecordWriterFactory newRecordWriterFactory();
/**
* Sets the type handler factory to use to create the stream definition.
* @param typeHandlerFactory the TypeHandlerFactory to use to
* create the stream definition
*/
public void setTypeHandlerFactory(TypeHandlerFactory typeHandlerFactory) {
this.typeHandlerFactory = typeHandlerFactory;
}
/**
* Returns the type handler factory for this stream format, thus allowing a stream
* format to override default type handlers.
* @return the type handler factory
* @since 1.1
*/
public TypeHandlerFactory getDefaultTypeHandlerFactory() {
return null;
}
/**
* Returns whether the stream definition must support reading
* an input stream.
* @return true if the stream definition must support reading
* an input stream
* @since 1.2
*/
public boolean isReadEnabled() {
return readEnabled;
}
/**
* Returns whether the stream definition must support writing to an
* output stream.
* @return true if the stream definition must support writing
* to an output stream
* @since 1.2
*/
public boolean isWriteEnabled() {
return writeEnabled;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy