Terrier5 (Terrier Information Retrieval Platform 5.5 API)

java.lang.Object
- org.terrier.utility.restructure.Terrier5

```
public class Terrier5
extends java.lang.Object
```
This Class allows the updating of a Terrier 4.x index to the specification of Terrier 5.x index. The main difference between these versions from a structure perspective was that addition of pluggable compression within the IndexOnDisk.

Since:

5.0

Author:

Richard McCreadie and Craig Macdonald

Field Summary

Fields
Modifier and Type Field Description

protected java.lang.String path

protected java.lang.String prefix

protected java.util.Properties properties

Constructor Summary

Constructors
Constructor	Description
`Terrier5()`	Use this method when you wish to specify the properties object to rewrite
`Terrier5(java.lang.String path, java.lang.String prefix)`	Use this method to load an index data.properties file and rewrite it

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`loadProperties(java.lang.String path, java.lang.String prefix)`	loads in the properties file, falling back to the Terrier 1.xx log file if no properties exist.
`static void`	`main(java.lang.String[] args)`
`void`	`updateIndexProperties()`
`void`	`updateIndexProperties(java.util.Properties indexProperties)`	This method takes re-writes the index properties for a Terrier 4.x index to making compatible with Terrier 5.x

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

- Field Detail
  - properties
```
protected java.util.Properties properties
```
  - path
```
protected java.lang.String path
```
  - prefix
```
protected java.lang.String prefix
```
- Constructor Detail
  - Terrier5
```
public Terrier5()
```
    Use this method when you wish to specify the properties object to rewrite
  - Terrier5
```
public Terrier5(java.lang.String path,
                java.lang.String prefix)
```
    Use this method to load an index data.properties file and rewrite it
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
  - updateIndexProperties
```
public void updateIndexProperties()
```
  - updateIndexProperties
```
public void updateIndexProperties(java.util.Properties indexProperties)
```
    This method takes re-writes the index properties for a Terrier 4.x index to making compatible with Terrier 5.x
    
    Parameters:
    
    indexProperties - properties object to alter
  - loadProperties
```
protected boolean loadProperties(java.lang.String path,
                                 java.lang.String prefix)
```
    loads in the properties file, falling back to the Terrier 1.xx log file if no properties exist.