DataContextProperties.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.metamodel.factory;

import java.io.Serializable;
import java.util.Map;

import javax.sql.DataSource;

import org.apache.metamodel.DataContext;
import org.apache.metamodel.schema.TableType;
import org.apache.metamodel.util.SimpleTableDef;

/**
 * Represents the {@link Serializable} properties used to fully describe and
 * construct a {@link DataContext}.
 */
public interface DataContextProperties extends Serializable {

    /**
     * Gets the type of {@link DataContext}, such as "csv" or "jdbc".
     * 
     * @return
     */
    String getDataContextType();

    /**
     * Gets all the properties represented as a {@link Map}. Note that any
     * unstandardized properties may also be exposed via this map.
     * 
     * @return
     */
    Map<String, Object> toMap();

    ResourceProperties getResourceProperties();

    Integer getColumnNameLineNumber();

    Boolean isSkipEmptyLines();

    Boolean isSkipEmptyColumns();

    String getEncoding();

    Character getSeparatorChar();

    Character getQuoteChar();

    Character getEscapeChar();

    Boolean isFailOnInconsistentRowLength();

    Boolean isMultilineValuesEnabled();

    TableType[] getTableTypes();

    String getCatalogName();

    String getUrl();

    DataSource getDataSource();

    String getUsername();

    String getPassword();

    String getDriverClassName();

    String getHostname();

    Integer getPort();

    String getDatabaseName();

    SimpleTableDef[] getTableDefs();
}