VDBDocument.java

/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.core.index;

import java.util.Collection;
import org.eclipse.emf.common.util.URI;
import org.teiid.designer.core.index.IDocument;

/**
 * VDBDocument contains references to a collection of resources that need to be indexed
 * It contains path to a dummy resource file for which these indexes built. We need a dummy
 * resource because JDT index framework needs an index to be associated with an resource file. 
 *
 * @since 8.0
 */
public interface VDBDocument extends IDocument {

    /**
     * Get the collection of {@link org.eclipse.emf.ecore.resource.Resource} 
     * instance that this document contains
     * @return collection of Resources for this document
     */
    Collection getResources();

    /**
     * Return the name of the file this document is indexed to
     * @return The name of the file to index this document
     */
    String getIndexName();
    
    /**
     * Return the relative path in the vdb to the {@link org.eclipse.emf.ecore.resource.Resource} 
     * instance with the specified URI
     * @param resourceURI the resource uri
     * @return The relative path in the vdb
     */
    String getModelPath(URI resourceURI);    
}