DiscourseFunction (SimpleNLG 4.5.0 API)

java.lang.Object
- java.lang.Enum<DiscourseFunction>
- - simplenlg.features.DiscourseFunction

All Implemented Interfaces:

Serializable, Comparable<DiscourseFunction>
```
public enum DiscourseFunction
extends Enum<DiscourseFunction>
```
An enumeration representing the grammatical function that an element might take. The discourse function is recorded under the Feature.DISCOURSE_FUNCTION feature and applies to any type of NLGElement.

Version:

4.0

Author:

A. Gatt and D. Westwater, University of Aberdeen.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUXILIARY` Auxiliaries are the additional verbs added to a verb phrase to alter the meaning being described.
`COMPLEMENT` Complements are additional components that are required to complement the meaning of a sentence.
`CONJUNCTION` A conjunction is a word that links items together in a coordinated phrase.
`CUE_PHRASE` Cue phrases are added to sentence to indicate document structure or flow.
`FRONT_MODIFIER` Front modifiers are modifiers that apply to clauses.
`HEAD` This represents the main item of the phrase.
`INDIRECT_OBJECT` This is the indirect object of a verb phrase or an additional object that is affected by the action performed.
`OBJECT` This is the object of a verb phrase and represents the item that the action is performed upon.
`POST_MODIFIER` Post-modifiers, typically adjectives and adverbs, are added after the head of the phrase.
`PRE_MODIFIER` Pre-modifiers, typically adjectives and adverbs, appear before the head of a phrase.
`SPECIFIER` The specifier, otherwise known as the determiner, is a word that can be placed before a noun in a noun phrase.
`SUBJECT` This is the subject of a verb phrase and represents the entity performing the action.
`VERB_PHRASE` The verb phrase highlights the part of a clause that forms the verb phrase.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static DiscourseFunction`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DiscourseFunction[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - AUXILIARY
```
public static final DiscourseFunction AUXILIARY
```
    Auxiliaries are the additional verbs added to a verb phrase to alter the meaning being described. For example, will can be added as an auxiliary to a verb phrase to represent the future tense of the verb, John will kiss Mary.
  - COMPLEMENT
```
public static final DiscourseFunction COMPLEMENT
```
    Complements are additional components that are required to complement the meaning of a sentence. For example, put the bread on the table requires the complement on the table to make the clause meaningful.
  - CONJUNCTION
```
public static final DiscourseFunction CONJUNCTION
```
    A conjunction is a word that links items together in a coordinated phrase. The most common conjunctions are and and but.
  - CUE_PHRASE
```
public static final DiscourseFunction CUE_PHRASE
```
    Cue phrases are added to sentence to indicate document structure or flow. They normally do not add any semantic information to the phrase. For example, Firstly, let me just say it is an honour to be here. Incidentally, John kissed Mary last night.
  - FRONT_MODIFIER
```
public static final DiscourseFunction FRONT_MODIFIER
```
    Front modifiers are modifiers that apply to clauses. They are placed in the syntactical structure after the cue phrase but before the subject. For example, However, last night John kissed Mary.
  - HEAD
```
public static final DiscourseFunction HEAD
```
    This represents the main item of the phrase. For verb phrases, the head will be the main verb. For noun phrases, the head will be the subject noun. For adjective, adverb and prepositional phrases, the head will be the adjective, adverb and preposition respectively.
  - INDIRECT_OBJECT
```
public static final DiscourseFunction INDIRECT_OBJECT
```
    This is the indirect object of a verb phrase or an additional object that is affected by the action performed. This is typically the recipient of give. For example, Mary is the indirect object in the phrase John gives Mary the flower.
  - OBJECT
```
public static final DiscourseFunction OBJECT
```
    This is the object of a verb phrase and represents the item that the action is performed upon. For example, the flower is the object in the phrase John gives Mary the flower.
  - PRE_MODIFIER
```
public static final DiscourseFunction PRE_MODIFIER
```
    Pre-modifiers, typically adjectives and adverbs, appear before the head of a phrase. They can apply to noun phrases and verb phrases. For example, the beautiful woman, the ferocious dog.
  - POST_MODIFIER
```
public static final DiscourseFunction POST_MODIFIER
```
    Post-modifiers, typically adjectives and adverbs, are added after the head of the phrase. For example, John walked quickly.
  - SPECIFIER
```
public static final DiscourseFunction SPECIFIER
```
    The specifier, otherwise known as the determiner, is a word that can be placed before a noun in a noun phrase. Example specifiers include: the, some, a and an as well as the personal pronouns such as my, your, their.
  - SUBJECT
```
public static final DiscourseFunction SUBJECT
```
    This is the subject of a verb phrase and represents the entity performing the action. For example, John is the subject in the phrase John gives Mary the flower.
  - VERB_PHRASE
```
public static final DiscourseFunction VERB_PHRASE
```
    The verb phrase highlights the part of a clause that forms the verb phrase. Verb phrases can be formed of a single verb or from a verb with a particle, such as kiss, talk, bark, fall down, pick up.
- Method Detail
  - values
```
public static DiscourseFunction[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DiscourseFunction c : DiscourseFunction.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DiscourseFunction valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum DiscourseFunction

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUXILIARY

COMPLEMENT

CONJUNCTION

CUE_PHRASE

FRONT_MODIFIER

HEAD

INDIRECT_OBJECT

OBJECT

PRE_MODIFIER

POST_MODIFIER

SPECIFIER

SUBJECT

VERB_PHRASE

Method Detail

values

valueOf