Interner (alto 2.2-SNAPSHOT API)

java.lang.Object
- de.up.ling.irtg.signature.Interner<E>

Type Parameters:

E - The type of objects which are interned by this interner.

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

IntSetInterner
```
public class Interner<E>
extends Object
implements Serializable, Cloneable
```
A class that maps back and forth between objects and int representations of these objects. The interner guarantees that adding two objects that are equals are assigned the same numeric ID.

Author:

koller

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Interner()
Creates an empty interner.

Constructors
Constructor and Description
`Interner()` Creates an empty interner.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addObject(E object)` Add an object to the interner.
`int`	`addObjectWithIndex(int index, E object)` Adds an object to the interner with a specific numeric ID.
`void`	`clear()` Removes all mappings from this interner.
`Object`	`clone()`
`IntSet`	`getKnownIds()` Returns the set of known numeric IDs.
`Set<E>`	`getKnownObjects()` Returns the set of all known objects.
`SignatureMapper`	`getMapperTo(Interner<E> other)` Creates an object that maps back and forth between the numeric IDs in this interner and those in another interner.
`int`	`getNextIndex()` Returns the numeric ID that will be assigned to the next object.
`Map<E,Integer>`	`getSymbolTable()` Returns a map from the objects known to the interner to the ids by which the objects are known.
`boolean`	`isKnownObject(E object)` Checks whether the object is known.
`boolean`	`isTrustingMode()` Returns whether the interner is currently in trusting mode, meaing it assumes that there will be no attempts to add the same object twice.
`E`	`normalize(E object)` Returns an object that is equals to "object" and identical to an object in the interner.
`int[]`	`remap(Interner<E> other)` Returns an arrary x such that the symbol i in this interner is the same as the symbol x[i] in the other interner.
`E`	`resolveId(int index)` Retrieves the object for the given numeric ID.
`Iterable<E>`	`resolveIds(Collection<Integer> indices)` Returns an iterable over the objects corresponding to the given collection of numeric IDs.
`int`	`resolveObject(E object)` Retrieves the numeric ID of the given object.
`void`	`retainOnly(IntSet retainedIds)` This removes from the interner all the objects that do not corresponds to ids in this given set.
`void`	`setTrustingMode(boolean trustingMode)` Switches the interner to "trusting mode".
`String`	`toString()`

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

- Constructor Detail
  - Interner
```
public Interner()
```
    Creates an empty interner.
- Method Detail
  - getMapperTo
```
public SignatureMapper getMapperTo(Interner<E> other)
```
    Creates an object that maps back and forth between the numeric IDs in this interner and those in another interner. It will map ids to each other if they correspond to the same object.
    
    Parameters:
    
    other -
    
    Returns:
  - clear
```
public void clear()
```
    Removes all mappings from this interner.
  - addObject
```
public int addObject(E object)
```
    Add an object to the interner. Normally, the method checks whether the interner already knows about the object, and returns its old ID in this case; otherwise the object is added with the next available ID, and that new ID is returned. If you are certain that you will not attempt to add the same object twice, you can switch the interner into "trusting mode" (see setTrustingMode(boolean)) to skip the exists-check for improved efficiency.
    
    Parameters:
    
    object -
    
    Returns:
  - addObjectWithIndex
```
public int addObjectWithIndex(int index,
                              E object)
```
    Adds an object to the interner with a specific numeric ID. You should only use this if you know what you're doing. Later additions to the interner are still guaranteed not to collide with your additions.
    
    Parameters:
    
    index -
    
    object -
    
    Returns:
  - resolveObject
```
public int resolveObject(E object)
```
    Retrieves the numeric ID of the given object. If the object is not known, the method returns 0.
    
    Parameters:
    
    object -
    
    Returns:
  - resolveId
```
public E resolveId(int index)
```
    Retrieves the object for the given numeric ID. If the ID is not known, the method returns null.
    
    Parameters:
    
    index -
    
    Returns:
  - resolveIds
```
public Iterable<E> resolveIds(Collection<Integer> indices)
```
    Returns an iterable over the objects corresponding to the given collection of numeric IDs.
    
    Parameters:
    
    indices -
    
    Returns:
  - isKnownObject
```
public boolean isKnownObject(E object)
```
    Checks whether the object is known.
    
    Parameters:
    
    object -
    
    Returns:
  - getKnownObjects
```
public Set<E> getKnownObjects()
```
    Returns the set of all known objects.
    
    Returns:
  - normalize
```
public E normalize(E object)
```
    Returns an object that is equals to "object" and identical to an object in the interner. If "object" was previously unknown to the interner, it is added.
    
    Parameters:
    
    object -
    
    Returns:
  - getKnownIds
```
public IntSet getKnownIds()
```
    Returns the set of known numeric IDs.
    
    Returns:
  - getNextIndex
```
public int getNextIndex()
```
    Returns the numeric ID that will be assigned to the next object.
    
    Returns:
  - getSymbolTable
```
public Map<E,Integer> getSymbolTable()
```
    Returns a map from the objects known to the interner to the ids by which the objects are known.
    
    Returns:
  - remap
```
public int[] remap(Interner<E> other)
```
    Returns an arrary x such that the symbol i in this interner is the same as the symbol x[i] in the other interner. If the symbol does not exist in the other interner, x[i] will be 0.
    
    Parameters:
    
    other -
    
    Returns:
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - retainOnly
```
public void retainOnly(IntSet retainedIds)
```
    This removes from the interner all the objects that do not corresponds to ids in this given set.
    
    Parameters:
    
    retainedIds -
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isTrustingMode
```
public boolean isTrustingMode()
```
    Returns whether the interner is currently in trusting mode, meaing it assumes that there will be no attempts to add the same object twice.
    
    Returns:
  - setTrustingMode
```
public void setTrustingMode(boolean trustingMode)
```
    Switches the interner to "trusting mode". In trusting mode, the interner trusts the caller to never try to intern the same object twice. This can be faster than if every objects is checked for equality to earlier objects, but if the same object is added to the interner in trusting mode twice, there will be two objects with the same ID. By default, interners start in trusting mode = false.
    
    Parameters:
    
    trustingMode -

Class Interner<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Interner

Method Detail

getMapperTo

clear

addObject

addObjectWithIndex

resolveObject

resolveId

resolveIds

isKnownObject

getKnownObjects

normalize

getKnownIds

getNextIndex

getSymbolTable

remap

clone

retainOnly

toString

isTrustingMode

setTrustingMode