IndexedFile (Metadata 13.1.2 API)

java.lang.Object
- org.teiid.internal.core.index.IndexedFile

All Implemented Interfaces:

Comparable<IndexedFile>, IQueryResult
```
public class IndexedFile
extends Object
implements IQueryResult, Comparable<IndexedFile>
```
An indexedFile associates a number to a document path, and document properties. It is what we add into an index, and the result of a query.

Field Summary

Fields
Modifier and Type Field Description

protected int fileNumber

protected String path

Constructor Summary

Constructors
Constructor Description

IndexedFile(String path, int fileNum)

IndexedFile(IDocument document, int fileNum)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(IndexedFile other)`
`int`	`footprint()`	Returns the size of the indexedFile.
`int`	`getFileNumber()`	Returns the file number.
`String`	`getPath()`	Returns the path.
`void`	`setFileNumber(int fileNumber)`	Sets the file number.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

path
```
protected String path
```

fileNumber
```
protected int fileNumber
```

Constructor Detail

IndexedFile

public IndexedFile(String path,
                   int fileNum)

IndexedFile

public IndexedFile(IDocument document,
                   int fileNum)

Method Detail
- footprint
```
public int footprint()
```
  Returns the size of the indexedFile.
- getFileNumber
```
public int getFileNumber()
```
  Returns the file number.
- getPath
```
public String getPath()
```
  Returns the path.
  
  Specified by:
  
  getPath in interface IQueryResult
- setFileNumber
```
public void setFileNumber(int fileNumber)
```
  Sets the file number.
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- compareTo
```
public int compareTo(IndexedFile other)
```
  Specified by:
  
  compareTo in interface Comparable<IndexedFile>