simplenlg.features

Enum ClauseStatus

java.lang.Object

java.lang.Enum<ClauseStatus>

simplenlg.features.ClauseStatus

All Implemented Interfaces:

Serializable, Comparable<ClauseStatus>

public enum ClauseStatus
extends Enum<ClauseStatus>

This is an enumeration of the two different types of clauses used in the SimplNLG package. Clauses can be either matrix or subordinate. Matrix clauses are not contained within any other clause and frequently span an entire sentence, whereas a subordinate clauses is contained within another clause.

As an example, take the phrase, whoever said it is wrong. This phrase has two clauses, one being the main clause and the other being a subordinate clause. The section in bold type highlights the subordinate clause. It is entirely contained within another clause. The matrix clause is of the form he is wrong or to be more general X is wrong. X can be replaced with a single subject or, as is the case here, by a subordinate clause.

The clause status is recorded under the Feature.CLAUSE_STATUS feature and applies only to clauses.

Copyright (C) 2010, University of Aberdeen

Version:

4.0

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
MATRIX This enumeration represents a matrix clause.
SUBORDINATE The subordinate clauses are contained within a higher clause.

Method Summary

Modifier and Type	Method and Description
static ClauseStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClauseStatus[]	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

MATRIX

public static final ClauseStatus MATRIX

This enumeration represents a matrix clause. A matrix clause is not subordinate to any other clause and therefore sits at the top-level of the clause hierarchy, typically spanning the whole sentence.

SUBORDINATE

public static final ClauseStatus SUBORDINATE

The subordinate clauses are contained within a higher clause.

Method Detail

values

public static ClauseStatus[] 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 (ClauseStatus c : ClauseStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClauseStatus 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