001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.db;
029
030import java.util.ArrayList;
031import java.util.List;
032
033/**
034 * Provides the user export settings.<p>
035 *
036 * @since 6.5.6
037 */
038public class CmsUserExportSettings {
039
040    /** The list of export values. */
041    private List<String> m_columns;
042
043    /** The separator used in export file. */
044    private String m_separator;
045
046    /**
047     * Public constructor.<p>
048     */
049    public CmsUserExportSettings() {
050
051        m_columns = new ArrayList<String>();
052    }
053
054    /**
055     * Public constructor.<p>
056     *
057     * @param separator the seperator to use during import
058     * @param columns the columns to export
059     */
060    public CmsUserExportSettings(String separator, List<String> columns) {
061
062        m_separator = separator;
063        m_columns = columns;
064    }
065
066    /**
067     * Adds a column to the list of export columns.<p>
068     *
069     * @param column column to add to export columns list
070     */
071    public void addColumn(String column) {
072
073        m_columns.add(column);
074    }
075
076    /**
077     * Returns the list of export columns.<p>
078     *
079     * @return the list of export columns
080     */
081    public List<String> getColumns() {
082
083        return m_columns;
084    }
085
086    /**
087     * Returns the export separator.<p>
088     *
089     * @return the export separator
090     */
091    public String getSeparator() {
092
093        return m_separator;
094    }
095
096    /**
097     * Sets the export columns.<p>
098     *
099     * @param columns the export columns to set
100     */
101    public void setColumns(List<String> columns) {
102
103        m_columns = columns;
104    }
105
106    /**
107     * Sets the export separator.<p>
108     *
109     * @param separator the export separator to set
110     */
111    public void setSeparator(String separator) {
112
113        m_separator = separator;
114    }
115}