org.batoo.jpa.parser.metadata.attribute.BasicAttributeMetadata Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of batoo-jpa Show documentation

There is a newer version: 2.0.1.2

/*
 * Copyright (c) 2012 - Batoo Software ve Consultancy Ltd.
 * 
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.batoo.jpa.parser.metadata.attribute;

import javax.persistence.EnumType;
import javax.persistence.FetchType;

import org.batoo.jpa.parser.metadata.IndexMetadata;

/**
 * Metadata for basic attributes.
 * 
 * @author hceylan
 * @since $version
 */
public interface BasicAttributeMetadata extends PhysicalAttributeMetadata {

	/**
	 * Returns the enumType of the basic attribute.
	 * 
	 * @return the enumType of the basic attribute
	 * 
	 * @since $version
	 * @author hceylan
	 */
	EnumType getEnumType();

	/**
	 * Returns the fetch type of the attribute.
	 * 
	 * @return the fetch type of the attribute
	 * 
	 * @since $version
	 * @author hceylan
	 */
	FetchType getFetchType();

	/**
	 * Returns the index definition.
	 * 
	 * @return the index definition
	 * 
	 * @since $version
	 * @author hceylan
	 */
	IndexMetadata getIndex();

	/**
	 * Returns if the basic attribute is lob.
	 * 
	 * @return true if the basic attribute is lob
	 * 
	 * @since $version
	 * @author hceylan
	 */
	boolean isLob();

	/**
	 * Returns if the basic attribute is optional.
	 * 
	 * @return true if the basic attribute is optional, false otherwise
	 * 
	 * @since $version
	 * @author hceylan
	 */
	boolean isOptional();
}