/*

BSD license

Copyright (c) 2005, Jean Lazarou
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list 
of conditions and the following disclaimer. 
Redistributions in binary form must reproduce the above copyright notice, this 
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution. 
Neither the name of the @home Company! nor the names of its contributors may be 
used to endorse or promote products derived from this software without specific 
prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
OF THE POSSIBILITY OF SUCH DAMAGE.

*/

/*
 * Created on 12-juil.-2005
 */
package net.sf.omap;

public interface MappingExpert {

    /**
     * Maps the given object using the registered mapper for the object's class in
     * default category
     <p>
     * If no mapper is found to map the given object returns <code>null</code>
     
     @param o the object to map
     @return the mapped object or null if no mapper was found
     */
    Object map(Object o);
    
    /**
     * Maps the given object using the registered mapper for the object's class in
     * the given <code>category</code>
     <p>
     * If the given category doesn't contain a mapper for the object's class, tries
     * to find one in the default category. If no default mapper is found the returned
     * value depends on the expert implementation (could be null, an empty string, 
     * etc.) 
     
     @param category the category in which to search for the registered mapper
     @param o the object to map
     
     @return the mapped object
     
     @throws MappingException if the category does not exist
     */
    Object map(String category, Object o);
    
    /**
     * Registers all the mappers defined by the given <code>definition</code> in the
     * default mapper category
     
     @param definition the mappers definition
     */
    void register(String definition);

    /**
     * Registers the mapper for the given class (<code>type</code>) in the
     * default mapper category.
     
     @param type the class to register with the mapper
     @param mapper the mapper to register
     */
    void register(Class type, ObjectMapper mapper);
    
    /**
     * Registers the mapper definition for the given <code>type</code> in the
     * default mapper category
     
     @param type the class to register with the mapper
     @param definition the mapper definition
     */
    void register(Class type, String definition);
    
    /**
     * Registers the mappers define by the given <code>definition</code> in the given
     <code>category</code>
     
     @param category the category in which to register the mapper
     @param definition the mapper definition
     */
    void register(String category, String definition);

    /**
     * Registers the mapper for the given class (<code>type</code>) in the
     * given mapper category.
     
     @param category the category in which to register the mapper
     @param type the class to register with the mapper
     @param mapper the mapper to register
     */
    void register(String category, Class type, ObjectMapper mapper);
    
    /**
     * Registers the mapper definition for the given <code>type</code> in the given
     <code>category</code>
     
     @param category the category in which to register the mapper
     @param type the class to register with the mapper
     @param definition the mapper definition
     */
    void register(String category, Class type, String definition);
    
}