DecompoundedWord (DKPro Core 1.9.0 API)

java.lang.Object
- de.tudarmstadt.ukp.dkpro.core.decompounding.splitter.DecompoundedWord

All Implemented Interfaces:

Comparable<DecompoundedWord>
```
public class DecompoundedWord
extends Object
implements Comparable<DecompoundedWord>
```
A data container for a split of a word. This container stores on split of all possible splits.

Constructor Summary

Constructors
Constructor and Description

DecompoundedWord()

Constructors
Constructor and Description
`DecompoundedWord()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAll(List<Fragment> aSplits)` Adds a list of split elements.
`void`	`appendSplitElement(Fragment aSplit)` Adds a split element at the end
`int`	`compareTo(DecompoundedWord aOtherSplit)`
`DecompoundedWord`	`createCopy()` Creates a copy of this element.
`static DecompoundedWord`	`createFromString(String aSplit)` Create a split from a string The string has the structure: word1(morpheme)+word2(morpheme)+...+word3 For example: "Aktion(s)+plan" or "Verbraucher+zahlen"
`boolean`	`equals(Object obj)`
`boolean`	`equalWithoutMorpheme(DecompoundedWord aOtherSplit)` Similar to the equals method, but combines morpheme and word
`int`	`getSplitPos()`
`List<Fragment>`	`getSplits()` Returns all split elements
`double`	`getWeight()` Returns the ranked weight of the split.
`String`	`getWord()` Returns the complete word without + or ()
`int`	`hashCode()`
`boolean`	`hasLastFragmentMorpheme()` Checks if last fragment has a linking morpheme.
`boolean`	`isCompound()` Checks if this instance is a compounding word.
`void`	`prependSplitElement(Fragment aSplit)` Adds a split element to the beginning
`void`	`replaceSplitElement(int aIndex, DecompoundedWord aSplit)` Replace one split element with a split.
`void`	`replaceSplitElement(int aIndex, Fragment aSplitElement)` Replaces a split element with another one
`void`	`setSplitPos(int aSplitPos)`
`void`	`setSplits(List<Fragment> aSplits)` Set all split elements
`void`	`setWeight(double aWeight)` Sets a rank weight for the split.
`String`	`toString()`

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

- Constructor Detail
  - DecompoundedWord
```
public DecompoundedWord()
```
- Method Detail
  - createFromString
```
public static DecompoundedWord createFromString(String aSplit)
```
    Create a split from a string The string has the structure: word1(morpheme)+word2(morpheme)+...+word3 For example: "Aktion(s)+plan" or "Verbraucher+zahlen"
    
    Parameters:
    
    aSplit - an string-encoded split
    
    Returns:
    
    the split word.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - appendSplitElement
```
public void appendSplitElement(Fragment aSplit)
```
    Adds a split element at the end
    
    Parameters:
    
    aSplit - a split.
  - prependSplitElement
```
public void prependSplitElement(Fragment aSplit)
```
    Adds a split element to the beginning
    
    Parameters:
    
    aSplit - a split.
  - getSplits
```
public List<Fragment> getSplits()
```
    Returns all split elements
    
    Returns:
    
    all split elements
  - setSplits
```
public void setSplits(List<Fragment> aSplits)
```
    Set all split elements
    
    Parameters:
    
    aSplits - all split elements.
  - addAll
```
public void addAll(List<Fragment> aSplits)
```
    Adds a list of split elements.
    
    Parameters:
    
    aSplits - list of fragments.
  - replaceSplitElement
```
public void replaceSplitElement(int aIndex,
                                DecompoundedWord aSplit)
```
    Replace one split element with a split. That means all split elements will be inserted at the position of the split element
    
    Parameters:
    
    aIndex - the index.
    
    aSplit - the split.
  - replaceSplitElement
```
public void replaceSplitElement(int aIndex,
                                Fragment aSplitElement)
```
    Replaces a split element with another one
    
    Parameters:
    
    aIndex - the index.
    
    aSplitElement - the fragement.
  - equalWithoutMorpheme
```
public boolean equalWithoutMorpheme(DecompoundedWord aOtherSplit)
```
    Similar to the equals method, but combines morpheme and word
    
    Parameters:
    
    aOtherSplit - a split.
    
    Returns:
    
    if they are equal without morpheme
  - getWord
```
public String getWord()
```
    Returns the complete word without + or ()
    
    Returns:
    
    the complete word without + or ()
  - createCopy
```
public DecompoundedWord createCopy()
```
    Creates a copy of this element.
    
    Returns:
    
    copy of this element.
  - getWeight
```
public double getWeight()
```
    Returns the ranked weight of the split.
    
    Returns:
    
    the ranked weight of the split.
  - setWeight
```
public void setWeight(double aWeight)
```
    Sets a rank weight for the split.
    
    Parameters:
    
    aWeight - rank weight for the split.
  - compareTo
```
public int compareTo(DecompoundedWord aOtherSplit)
```
    Specified by:
    
    compareTo in interface Comparable<DecompoundedWord>
  - setSplitPos
```
public void setSplitPos(int aSplitPos)
```
  - getSplitPos
```
public int getSplitPos()
```
  - isCompound
```
public boolean isCompound()
```
    Checks if this instance is a compounding word.
    
    Returns:
    
    true if this instance is a decompounded word
  - hasLastFragmentMorpheme
```
public boolean hasLastFragmentMorpheme()
```
    Checks if last fragment has a linking morpheme.
    
    Returns:
    
    true if this instance does not have a linking morpheme in the last fragment

Class DecompoundedWord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DecompoundedWord

Method Detail

createFromString

hashCode

equals

toString

appendSplitElement

prependSplitElement

getSplits

setSplits

addAll

replaceSplitElement

replaceSplitElement

equalWithoutMorpheme

getWord

createCopy

getWeight

setWeight

compareTo

setSplitPos

getSplitPos

isCompound

hasLastFragmentMorpheme