/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* MetaMatrix, Inc - repackaging and updates for use as a metadata store
*******************************************************************************/
package com.metamatrix.core.index;
/**
* An IDocument
represent a data source, e.g. a File
(FileDocument
),
* an IFile
(IFileDocument
),
* or other kinds of data sources (URL, ...). An IIndexer
indexes anIDocument
.
*/
public interface IDocument {
/**
* Returns the encoding for this document
*/
String getEncoding();
/**
* returns the name of the document (e.g. its path for a File
, or its relative path
* in the workbench for an IFile
).
*/
String getName();
/**
* Returns the type of the document.
*/
String getType();
}