DefaultMapper.java

/*
 * Copyright 2004-2012 the original author or authors.
 * 
 * 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
 * 
 *      https://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.springframework.binding.mapping.impl;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.binding.mapping.Mapper;
import org.springframework.binding.mapping.Mapping;
import org.springframework.binding.mapping.MappingResults;
import org.springframework.core.style.ToStringCreator;

/**
 * Generic mapper implementation that allows mappings to be configured programatically.
 * 
 * @see #addMapping(DefaultMapping)
 * @author Keith Donald
 */
public class DefaultMapper implements Mapper {

	private static final Log logger = LogFactory.getLog(DefaultMapper.class);

	private List<DefaultMapping> mappings = new ArrayList<>();

	/**
	 * Add a mapping to this mapper.
	 * @param mapping the mapping to add (required)
	 * @return this, to support convenient call chaining
	 */
	public DefaultMapper addMapping(DefaultMapping mapping) {
		mappings.add(mapping);
		return this;
	}

	/**
	 * Returns this mapper's list of mappings.
	 * @return the list of mappings
	 */
	public Mapping[] getMappings() {
		return mappings.toArray(new Mapping[mappings.size()]);
	}

	public MappingResults map(Object source, Object target) {
		if (logger.isDebugEnabled()) {
			logger.debug("Beginning mapping between source [" + source.getClass().getName() + "] and target ["
					+ target.getClass().getName() + "]");
		}
		DefaultMappingContext context = new DefaultMappingContext(source, target);
		for (DefaultMapping mapping : mappings) {
			mapping.map(context);
		}
		MappingResults results = context.getMappingResults();
		if (logger.isDebugEnabled()) {
			logger.debug("Completing mapping between source [" + source.getClass().getName() + "] and target ["
					+ target.getClass().getName() + "]; total mappings = " + results.getAllResults().size()
					+ "; total errors = " + results.getErrorResults().size());
		}
		return results;
	}

	public String toString() {
		return new ToStringCreator(this).append("mappings", mappings).toString();
	}
}