XmlSPhraseSpec (SimpleNLG 4.5.0 API)

java.lang.Object
- simplenlg.xmlrealiser.wrapper.XmlNLGElement
- - simplenlg.xmlrealiser.wrapper.XmlPhraseElement
  - - simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

public class XmlSPhraseSpec
extends XmlPhraseElement

Java class for SPhraseSpec complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="SPhraseSpec">
   <complexContent>
     <extension base="{https://github.com/simplenlg/simplenlg/tree/master/src/main/resources/xml}PhraseElement">
       <sequence>
         <element name="cuePhrase" type="{https://github.com/simplenlg/simplenlg/tree/master/src/main/resources/xml}NLGElement" minOccurs="0"/>
         <element name="subj" type="{https://github.com/simplenlg/simplenlg/tree/master/src/main/resources/xml}NLGElement" maxOccurs="unbounded" minOccurs="0"/>
         <element name="vp" type="{https://github.com/simplenlg/simplenlg/tree/master/src/main/resources/xml}NLGElement"/>
       </sequence>
       <attGroup ref="{https://github.com/simplenlg/simplenlg/tree/master/src/main/resources/xml}sPhraseAtts"/>
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`aggregateauxiliary`
`protected XmlClauseStatus`	`clausestatus`
`protected String`	`complementiser`
`protected XmlNLGElement`	`cuePhrase`
`protected XmlForm`	`form`
`protected XmlInterrogativeType`	`interrogativetype`
`protected String`	`modal`
`protected Boolean`	`negated`
`protected Boolean`	`passive`
`protected Boolean`	`perfect`
`protected XmlPerson`	`person`
`protected Boolean`	`progressive`
`protected List<XmlNLGElement>`	`subj`
`protected Boolean`	`suppressgenitiveingerund`
`protected Boolean`	`supressedcomplementiser`
`protected XmlTense`	`tense`
`protected XmlNLGElement`	`vp`

Fields inherited from class simplenlg.xmlrealiser.wrapper.XmlPhraseElement
appositive, cat, compl, discourseFunction, frontMod, head, postMod, preMod

Constructor Summary

Constructors
Constructor and Description

XmlSPhraseSpec()

Constructors
Constructor and Description
`XmlSPhraseSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XmlClauseStatus`	`getCLAUSESTATUS()` Gets the value of the clausestatus property.
`String`	`getCOMPLEMENTISER()` Gets the value of the complementiser property.
`XmlNLGElement`	`getCuePhrase()` Gets the value of the cuePhrase property.
`XmlForm`	`getFORM()` Gets the value of the form property.
`XmlInterrogativeType`	`getINTERROGATIVETYPE()` Gets the value of the interrogativetype property.
`String`	`getMODAL()` Gets the value of the modal property.
`XmlPerson`	`getPERSON()` Gets the value of the person property.
`List<XmlNLGElement>`	`getSubj()` Gets the value of the subj property.
`XmlTense`	`getTENSE()` Gets the value of the tense property.
`XmlNLGElement`	`getVp()` Gets the value of the vp property.
`Boolean`	`isAGGREGATEAUXILIARY()` Gets the value of the aggregateauxiliary property.
`Boolean`	`isNEGATED()` Gets the value of the negated property.
`Boolean`	`isPASSIVE()` Gets the value of the passive property.
`Boolean`	`isPERFECT()` Gets the value of the perfect property.
`Boolean`	`isPROGRESSIVE()` Gets the value of the progressive property.
`Boolean`	`isSUPPRESSGENITIVEINGERUND()` Gets the value of the suppressgenitiveingerund property.
`Boolean`	`isSUPRESSEDCOMPLEMENTISER()` Gets the value of the supressedcomplementiser property.
`void`	`setAGGREGATEAUXILIARY(Boolean value)` Sets the value of the aggregateauxiliary property.
`void`	`setCLAUSESTATUS(XmlClauseStatus value)` Sets the value of the clausestatus property.
`void`	`setCOMPLEMENTISER(String value)` Sets the value of the complementiser property.
`void`	`setCuePhrase(XmlNLGElement value)` Sets the value of the cuePhrase property.
`void`	`setFORM(XmlForm value)` Sets the value of the form property.
`void`	`setINTERROGATIVETYPE(XmlInterrogativeType value)` Sets the value of the interrogativetype property.
`void`	`setMODAL(String value)` Sets the value of the modal property.
`void`	`setNEGATED(Boolean value)` Sets the value of the negated property.
`void`	`setPASSIVE(Boolean value)` Sets the value of the passive property.
`void`	`setPERFECT(Boolean value)` Sets the value of the perfect property.
`void`	`setPERSON(XmlPerson value)` Sets the value of the person property.
`void`	`setPROGRESSIVE(Boolean value)` Sets the value of the progressive property.
`void`	`setSUPPRESSGENITIVEINGERUND(Boolean value)` Sets the value of the suppressgenitiveingerund property.
`void`	`setSUPRESSEDCOMPLEMENTISER(Boolean value)` Sets the value of the supressedcomplementiser property.
`void`	`setTENSE(XmlTense value)` Sets the value of the tense property.
`void`	`setVp(XmlNLGElement value)` Sets the value of the vp property.

Methods inherited from class simplenlg.xmlrealiser.wrapper.XmlPhraseElement
getCat, getCompl, getDiscourseFunction, getFrontMod, getHead, getPostMod, getPreMod, isAppositive, setAppositive, setCat, setDiscourseFunction, setHead

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

- Field Detail
  - cuePhrase
```
protected XmlNLGElement cuePhrase
```
  - subj
```
protected List<XmlNLGElement> subj
```
  - vp
```
protected XmlNLGElement vp
```
  - aggregateauxiliary
```
protected Boolean aggregateauxiliary
```
  - clausestatus
```
protected XmlClauseStatus clausestatus
```
  - complementiser
```
protected String complementiser
```
  - form
```
protected XmlForm form
```
  - interrogativetype
```
protected XmlInterrogativeType interrogativetype
```
  - modal
```
protected String modal
```
  - negated
```
protected Boolean negated
```
  - passive
```
protected Boolean passive
```
  - perfect
```
protected Boolean perfect
```
  - person
```
protected XmlPerson person
```
  - progressive
```
protected Boolean progressive
```
  - suppressgenitiveingerund
```
protected Boolean suppressgenitiveingerund
```
  - supressedcomplementiser
```
protected Boolean supressedcomplementiser
```
  - tense
```
protected XmlTense tense
```
- Constructor Detail
  - XmlSPhraseSpec
```
public XmlSPhraseSpec()
```
- Method Detail
  - getCuePhrase
```
public XmlNLGElement getCuePhrase()
```
    Gets the value of the cuePhrase property.
    
    Returns:
    
    possible object is XmlNLGElement
  - setCuePhrase
```
public void setCuePhrase(XmlNLGElement value)
```
    Sets the value of the cuePhrase property.
    
    Parameters:
    
    value - allowed object is XmlNLGElement
  - getSubj
```
public List<XmlNLGElement> getSubj()
```
    Gets the value of the subj property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the subj property.
    For example, to add a new item, do as follows:
```
    getSubj().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list XmlNLGElement
  - getVp
```
public XmlNLGElement getVp()
```
    Gets the value of the vp property.
    
    Returns:
    
    possible object is XmlNLGElement
  - setVp
```
public void setVp(XmlNLGElement value)
```
    Sets the value of the vp property.
    
    Parameters:
    
    value - allowed object is XmlNLGElement
  - isAGGREGATEAUXILIARY
```
public Boolean isAGGREGATEAUXILIARY()
```
    Gets the value of the aggregateauxiliary property.
    
    Returns:
    
    possible object is Boolean
  - setAGGREGATEAUXILIARY
```
public void setAGGREGATEAUXILIARY(Boolean value)
```
    Sets the value of the aggregateauxiliary property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getCLAUSESTATUS
```
public XmlClauseStatus getCLAUSESTATUS()
```
    Gets the value of the clausestatus property.
    
    Returns:
    
    possible object is XmlClauseStatus
  - setCLAUSESTATUS
```
public void setCLAUSESTATUS(XmlClauseStatus value)
```
    Sets the value of the clausestatus property.
    
    Parameters:
    
    value - allowed object is XmlClauseStatus
  - getCOMPLEMENTISER
```
public String getCOMPLEMENTISER()
```
    Gets the value of the complementiser property.
    
    Returns:
    
    possible object is String
  - setCOMPLEMENTISER
```
public void setCOMPLEMENTISER(String value)
```
    Sets the value of the complementiser property.
    
    Parameters:
    
    value - allowed object is String
  - getFORM
```
public XmlForm getFORM()
```
    Gets the value of the form property.
    
    Returns:
    
    possible object is XmlForm
  - setFORM
```
public void setFORM(XmlForm value)
```
    Sets the value of the form property.
    
    Parameters:
    
    value - allowed object is XmlForm
  - getINTERROGATIVETYPE
```
public XmlInterrogativeType getINTERROGATIVETYPE()
```
    Gets the value of the interrogativetype property.
    
    Returns:
    
    possible object is XmlInterrogativeType
  - setINTERROGATIVETYPE
```
public void setINTERROGATIVETYPE(XmlInterrogativeType value)
```
    Sets the value of the interrogativetype property.
    
    Parameters:
    
    value - allowed object is XmlInterrogativeType
  - getMODAL
```
public String getMODAL()
```
    Gets the value of the modal property.
    
    Returns:
    
    possible object is String
  - setMODAL
```
public void setMODAL(String value)
```
    Sets the value of the modal property.
    
    Parameters:
    
    value - allowed object is String
  - isNEGATED
```
public Boolean isNEGATED()
```
    Gets the value of the negated property.
    
    Returns:
    
    possible object is Boolean
  - setNEGATED
```
public void setNEGATED(Boolean value)
```
    Sets the value of the negated property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isPASSIVE
```
public Boolean isPASSIVE()
```
    Gets the value of the passive property.
    
    Returns:
    
    possible object is Boolean
  - setPASSIVE
```
public void setPASSIVE(Boolean value)
```
    Sets the value of the passive property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isPERFECT
```
public Boolean isPERFECT()
```
    Gets the value of the perfect property.
    
    Returns:
    
    possible object is Boolean
  - setPERFECT
```
public void setPERFECT(Boolean value)
```
    Sets the value of the perfect property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getPERSON
```
public XmlPerson getPERSON()
```
    Gets the value of the person property.
    
    Returns:
    
    possible object is XmlPerson
  - setPERSON
```
public void setPERSON(XmlPerson value)
```
    Sets the value of the person property.
    
    Parameters:
    
    value - allowed object is XmlPerson
  - isPROGRESSIVE
```
public Boolean isPROGRESSIVE()
```
    Gets the value of the progressive property.
    
    Returns:
    
    possible object is Boolean
  - setPROGRESSIVE
```
public void setPROGRESSIVE(Boolean value)
```
    Sets the value of the progressive property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSUPPRESSGENITIVEINGERUND
```
public Boolean isSUPPRESSGENITIVEINGERUND()
```
    Gets the value of the suppressgenitiveingerund property.
    
    Returns:
    
    possible object is Boolean
  - setSUPPRESSGENITIVEINGERUND
```
public void setSUPPRESSGENITIVEINGERUND(Boolean value)
```
    Sets the value of the suppressgenitiveingerund property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isSUPRESSEDCOMPLEMENTISER
```
public Boolean isSUPRESSEDCOMPLEMENTISER()
```
    Gets the value of the supressedcomplementiser property.
    
    Returns:
    
    possible object is Boolean
  - setSUPRESSEDCOMPLEMENTISER
```
public void setSUPRESSEDCOMPLEMENTISER(Boolean value)
```
    Sets the value of the supressedcomplementiser property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getTENSE
```
public XmlTense getTENSE()
```
    Gets the value of the tense property.
    
    Returns:
    
    possible object is XmlTense
  - setTENSE
```
public void setTENSE(XmlTense value)
```
    Sets the value of the tense property.
    
    Parameters:
    
    value - allowed object is XmlTense

Class XmlSPhraseSpec

Field Summary

Fields inherited from class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Constructor Summary

Method Summary

Methods inherited from class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Methods inherited from class java.lang.Object

Field Detail

cuePhrase

subj

vp

aggregateauxiliary

clausestatus

complementiser

form

interrogativetype

modal

negated

passive

perfect

person

progressive

suppressgenitiveingerund

supressedcomplementiser

tense

Constructor Detail

XmlSPhraseSpec

Method Detail

getCuePhrase

setCuePhrase

getSubj

getVp

setVp

isAGGREGATEAUXILIARY

setAGGREGATEAUXILIARY

getCLAUSESTATUS

setCLAUSESTATUS

getCOMPLEMENTISER

setCOMPLEMENTISER

getFORM

setFORM

getINTERROGATIVETYPE

setINTERROGATIVETYPE

getMODAL

setMODAL

isNEGATED

setNEGATED

isPASSIVE

setPASSIVE

isPERFECT

setPERFECT

getPERSON

setPERSON

isPROGRESSIVE

setPROGRESSIVE

isSUPPRESSGENITIVEINGERUND

setSUPPRESSGENITIVEINGERUND

isSUPRESSEDCOMPLEMENTISER

setSUPRESSEDCOMPLEMENTISER

getTENSE

setTENSE