/*
 * The contents of this file are subject to the terms 
 * of the Common Development and Distribution License 
 * (the "License").  You may not use this file except 
 * in compliance with the License.
 * 
 * You can obtain a copy of the license at 
 * glassfish/bootstrap/legal/CDDLv1.0.txt or 
 * https://glassfish.dev.java.net/public/CDDLv1.0.html. 
 * See the License for the specific language governing 
 * permissions and limitations under the License.
 * 
 * When distributing Covered Code, include this CDDL 
 * HEADER in each file and include the License file at 
 * glassfish/bootstrap/legal/CDDLv1.0.txt.  If applicable, 
 * add the following below this CDDL HEADER, with the 
 * fields enclosed by brackets "[]" replaced with your 
 * own identifying information: Portions Copyright [yyyy] 
 * [name of copyright owner]
 */
// Copyright (c) 1998, 2007, Oracle. All rights reserved.  
package oracle.toplink.essentials.internal.ejb.cmp3.metadata.queries;

import java.util.List;

/**
 * Object to hold onto a named query metadata's hints.
 * 
 * @author Guy Pelletier
 * @since TopLink EJB 3.0 Reference Implementation
 */
public abstract class MetadataQuery  {
    protected Object m_javaClass; // Where this query was found.
    protected List<MetadataQueryHint> m_hints;
    
    /**
     * INTERNAL:
     */
    protected MetadataQuery() {}
    
    /**
     * INTERNAL:
     */
    protected MetadataQuery(Class javaClass) {
        m_javaClass = javaClass;
    }
    
    /**
     * INTERNAL:
     */
    public abstract String getIgnoreLogMessageContext();
    
    /**
     * INTERNAL: (Overridden in XMLNamedNativeQuery and XMLNamedQuery)
     */
    public Object getLocation() {
        return m_javaClass;
    }
    
    /**
     * INTERNAL: (Overriden in XMLNamedNativeQuery and XMLNamedQuery)
     */
    public boolean loadedFromAnnotations() {
        return true;
    }
    
    /**
     * INTERNAL: (Overriden in XMLNamedNativeQuery and XMLNamedQuery)
     */
    public boolean loadedFromXML() {
        return false;
    }    
}
