core/src/main/java/org/apache/metamodel/schema/naming/ColumnNamingContext.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.schema.naming;

import org.apache.metamodel.schema.Table;

/**
 * Defines the context for naming a single column in a
 * {@link ColumnNamingStrategy} session.
 */
public interface ColumnNamingContext {

    /**
     * Gets the index of the column being named.
     * 
     * @return
     */
    public int getColumnIndex();

    /**
     * Gets the {@link Table} that the column is to pertain to. If the table is
     * not yet available then this may return null.
     * 
     * @return
     */
    public Table getTable();

    /**
     * Gets the intrinsic column name, if this is defined in the datastore
     * itself. This may be in the form of a header or such. Sometimes intrinsic
     * column names exist only for some columns and sometimes there may be
     * duplicate names or other anomalies which are often discouraged.
     * 
     * @return
     */
    public String getIntrinsicColumnName();
}