HSearchTypeDescriptor.java

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * JBoss, Home of Professional Open Source
 * Copyright 2013 Red Hat Inc. and/or its affiliates and other contributors
 * as indicated by the @authors tag. All rights reserved.
 * See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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, v. 2.1.
 * This program is distributed in the hope that it will be useful, but WITHOUT A
 * 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,
 * v.2.1 along with this distribution; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA  02110-1301, USA.
 */
package org.hibernate.hql.lucene.internal.ast;

import org.hibernate.hql.ast.TypeDescriptor;

/**
 * A {@link TypeDescriptor} backed by HSearch type meta-data.
 *
 * @author Gunnar Morling
 */
public interface HSearchTypeDescriptor extends TypeDescriptor {

	/**
	 * Returns the Java type of the represented indexed entity.
	 *
	 * @return the Java type of the represented indexed entity
	 */
	Class<?> getIndexedEntityType();

	/**
	 * Whether the given property of this indexed entity is analyzed or not.
	 *
	 * @param propertyName the name of the property
	 * @return {@code true} if the given property is analyed, {@code false} otherwise.
	 */
	boolean isAnalyzed(String propertyName);

	/**
	 * Whether the given property denotes an embedded entity or not.
	 *
	 * @param propertyName the name of the property
	 * @return {@code true} if the given property denotes an entity embedded into this one, {@code false} otherwise.
	 */
	boolean isEmbedded(String propertyName);
}