/*
 * jDocBook, processing of DocBook sources
 *
 * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * 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.hibernate.persister.walking.spi;

import org.hibernate.type.Type;

Author:
Steve Ebersole/**
 * @author Steve Ebersole
 */
public interface CollectionIndexDefinition {
	
Returns the collection definition.
Returns:
 the collection definition./**
	 * Returns the collection definition.
	 * @return  the collection definition.
	 */
	public CollectionDefinition getCollectionDefinition();
	
Returns the collection index type.
Returns:
the collection index type/**
	 * Returns the collection index type.
	 * @return the collection index type
	 */
	public Type getType();
	
If the index type returned by getType() is an EntityType, then the entity definition for the collection index is returned; otherwise, IllegalStateException is thrown. 
Throws:
IllegalStateException – if the collection index type returned by getType() is not of type EntityType.
Returns:
the entity definition for the collection index./**
	 * If the index type returned by {@link #getType()} is an
	 * {@link org.hibernate.type.EntityType}, then the entity
	 * definition for the collection index is returned;
	 * otherwise, IllegalStateException is thrown.
	 *
	 * @return the entity definition for the collection index.
	 *
	 * @throws IllegalStateException if the collection index type
	 * returned by {@link #getType()} is not of type
	 * {@link org.hibernate.type.EntityType}.
	 */
	public EntityDefinition toEntityDefinition();
	
If the index type returned by getType() is a CompositeType, then the composite index definition for the collection index is returned; otherwise, IllegalStateException is thrown. 
Throws:
IllegalStateException – if the collection index type returned by getType() is not of type CompositeType.
Returns:
the composite index definition for the collection index./**
	 * If the index type returned by {@link #getType()} is a
	 * {@link org.hibernate.type.CompositeType}, then the composite
	 * index definition for the collection index is returned;
	 * otherwise, IllegalStateException is thrown.
	 *
	 * @return the composite index definition for the collection index.
	 *
	 * @throws IllegalStateException if the collection index type
	 * returned by {@link #getType()} is not of type
	 * {@link org.hibernate.type.CompositeType}.
	 */
	public CompositionDefinition toCompositeDefinition();

	
If the index type returned by getType() is an AnyType, then the any mapping definition for the collection index is returned; otherwise, IllegalStateException is thrown. 
Throws:
IllegalStateException – if the collection index type returned by getType() is not of type AnyType.
Returns:
the any mapping definition for the collection index./**
	 * If the index type returned by {@link #getType()} is an
	 * {@link org.hibernate.type.AnyType}, then the any mapping
	 * definition for the collection index is returned;
	 * otherwise, IllegalStateException is thrown.
	 *
	 * @return the any mapping definition for the collection index.
	 *
	 * @throws IllegalStateException if the collection index type
	 * returned by {@link #getType()} is not of type
	 * {@link org.hibernate.type.AnyType}.
	 */
	public AnyMappingDefinition toAnyMappingDefinition();
}