tools/org.eclipse.persistence.tools.mapping/src/org/eclipse/persistence/tools/mapping/orm/ExternalOrderColumn.java

/*******************************************************************************
 * Copyright (c) 2006, 2013 Oracle and/or its affiliates. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Oracle - initial API and implementation
 *
 ******************************************************************************/
package org.eclipse.persistence.tools.mapping.orm;

import org.eclipse.persistence.tools.mapping.ExternalForm;
import org.eclipse.persistence.tools.utility.TextRange;

/**
 * This interface describes the core definition of what an order column is as defined by the
 * EclipseLink JPA spec that are available for configuration via the EclipseLink ORM xml.
 * <p>
 * Provisional API: This interface is part of an interim API that is still under development and
 * expected to change significantly before reaching stability. It is available at this early stage
 * to solicit feedback from pioneering adopters on the understanding that any code that uses this
 * API will almost certainly be broken (repeatedly) as the API evolves.<p>
 *
 * @version 2.6
 */
@SuppressWarnings("nls")
public interface ExternalOrderColumn extends ExternalForm {

	/**
	 * The attribute name used to store and retrieve the base property.
	 */
	String BASE = "base";

	/**
	 * The attribute name used to store and retrieve the column-definition of the property.
	 */
	String COLUMN_DEFINITION = "column-definition";

	/**
	 * The attribute name used to store and retrieve the contiguous property.
	 */
	String CONTIGUOUS = "contiguous";

	/**
	 * The attribute name used to store and retrieve the insertable property.
	 */
	String INSERTABLE = "insertable";

	/**
	 * The attribute name used to store and retrieve the name property.
	 */
	String NAME = "name";

	/**
	 * The attribute name used to store and retrieve the nullable property.
	 */
	String NULLABLE = "nullable";

	/**
	 * The attribute name used to store and retrieve the primary-key of the property.
	 */
	String ORDER_COLUMN = "order-column";

	/**
	 * The attribute name used to store and retrieve the table property.
	 */
	String TABLE = "table";

	/**
	 * The attribute name used to store and retrieve the updatable property.
	 */
	String UPDATABLE = "updatable";

	/**
	 * Returns the base for this column.
	 */
	Integer getBase();

	/**
	 * Returns the {@link TextRange for the base value.
	 */
	TextRange getBaseTextRange();

	/**
	 * Returns the native DDL or definition string representing this column.
	 */
	String getColumnDefinition();

	/**
	 * Returns the {@link TextRange} for the column definition value.
	 */
	TextRange getColumnDefinitionTextRange();

	/**
	 * Returns the {@link TextRange} for the contiguous value.
	 */
	TextRange getContiguousTextRange();

	/**
	 * Returns the {@link TextRange} for the insertable value.
	 */
	TextRange getInstertableTextRange();

	/**
	 * Returns the column name.
	 */
	String getName();

	/**
	 * Returns the text range of the name attribute.
	 */
	TextRange getNameTextRange();

	/**
	 * Returns the {@link TextRange} for the nullable value.
	 */
	TextRange getNullableTextRange();

	/**
	 * Returns name of the owning table for this column.
	 */
	String getTable();

	/**
	 * Returns the {@link TextRange} for the owning table for this column.
	 */
	TextRange getTableTextRange();

	/**
	 * Returns the {@link TextRange} for the updatable value.
	 */
	TextRange getUpdatableTextRange();

	/**
	 * Indicates whether this column is contiguous.
	 */
	Boolean isContiguous();

	/**
	 * Indicates whether this column is insertable.
	 */
	Boolean isInstertable();

	/**
	 * Indicates whether this column is nullable.
	 */
	Boolean isNullable();

	/**
	 * Indicates whether this column is updatable.
	 */
	Boolean isUpdatable();

	/**
	 * Removes all metadata associated with this column from the the external form.
	 */
	void removeColumn();

	/**
	 * Removes itself from its parent.
	 */
	void removeSelf();

	/**
	 * Returns the base for this column.
	 */
	void setBase(Integer base);

	/**
	 * Sets the column definition.
	 */
	void setColumnDefinition(String columnDefinition);

	/**
	 * Sets the boolean value of whether the column is contiguous.
	 */
	void setContiguous(Boolean unique);

	/**
	 * Sets the boolean value of whether the column is insertable.
	 */
	void setInsertable(Boolean insertable);

	/**
	 * Sets the name of the column.
	 */
	void setName(String name);

	/**
	 * Sets the boolean value of whether the column is nullable.
	 */
	void setNullable(Boolean nullable);

	/**
	 * Sets the table name.
	 */
	void setTable(String table);

	/**
	 * Sets the boolean value of whether the column is updatable.
	 */
	void setUpdatable(Boolean updatable);
}