org.nerd4j.csv.conf.mapping.xml.XMLHandlerConf Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nerd4j-csv Show documentation
CSV manipulation library.
There is a newer version: 1.2.0
/*
 * #%L
 * Nerd4j CSV
 * %%
 * Copyright (C) 2013 Nerd4j
 * %%
 * 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 General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */
package org.nerd4j.csv.conf.mapping.xml;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlType;

import org.nerd4j.dependency.DependentBean;



/**
 * Abstract common representation of an XML configuration
 * for objects able to handle CSV.
 * 
 * This class implements the {@link DependentBean} interface
 * that allows dependencies to be automatically resolved.
 * 
 * @author Nerd4j Team
 */
@XmlType(name="handler")
public class XMLHandlerConf implements DependentBean
{

    /** The name of the reader instance. */
    private String name;
    
    /** The name of the configuration to inherit from. */
    private String inherit;
    
    /** The configuration which the current depends from. */ 
    private XMLHandlerConf dependency;

    /** List of configured columns. */
    private List columns;

    /** The model binder configuration. */
    private XMLModelBinderConf modelBinder;
    
    
    /**
     * Default constructor.
     * 
     */
    public XMLHandlerConf()
    {

        super();
    
        this.name = null;
        this.inherit = null;
        this.dependency = null;
        this.modelBinder = null;
        this.columns = new ArrayList();
        
    }
    
    
    /* ******************* */
    /*  GETTERS & SETTERS  */
    /* ******************* */
    
    
    @XmlAttribute(name="name",required=true)
    public String getName()
    {
        return name;
    }

    public void setName( String name )
    {
        this.name = name;
    }
    
    @XmlAttribute(name="inherit",required=false)
    public String getInherit()
    {
        return inherit;
    }
    
    public void setInherit( String inherit )
    {
        this.inherit = inherit;
    }
    
    @XmlElement(name="column",required=true)
    @XmlElementWrapper(name="columns",required=true)
    public List getColumns()
    {
        return columns;
    }
    
    public void setColumns( List columns )
    {
        this.columns = columns;
    }

    @XmlElement(name="model-binder",required=false)
    public XMLModelBinderConf getModelBinder()
    {
        return modelBinder;
    }
    
    public void setModelBinder( XMLModelBinderConf modelBinder )
    {
        this.modelBinder = modelBinder;
    }

    
    /* ******************* */
    /*  INTERFACE METHODS  */
    /* ******************* */
    

    /**
     * {@inheritDoc}
     */
    @Override
    public Set getDependencies()
    {
        if( this.dependency != null )
            return Collections.singleton( this.dependency );
        else
            return Collections.emptySet();
    }

    public void setDependency( XMLHandlerConf dependency )
    {
        this.dependency = dependency;
    }

}