Referent (CharGer4 Documentation)

Object
- charger.obj.Referent

```
public class Referent
extends Object
```
An abstraction of a CG referent, encapsulating all the various options. The actual parsing of the referent is delegated to the CGIFParser, which has a "referent" method that populates this object correctly.

Author:

Harry S. Delugach (delugach@uah.edu)

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`asEntered` The referent string as entered (un-edited, un-parsed) by a user or external system.
`private String`	`cardinality` If a set, this is where its cardinality is kept.
`private String`	`cgifVariableReference` The variable reference for CGIF.
`static String`	`coll`
`static String`	`dist`
`static String`	`forall` The forall symbol that can serve as a referent
`private InputStream`	`is`
`private boolean`	`isASet` Whether this referent denotes a set or not
`private String`	`marker` If the referent is an actual individual marker
`private Double`	`number` If referent denotes an actual number, here's where it's kept.
`private CGIFParser`	`parser`
`private ArrayList<Referent>`	`setMembers` If a set, these are the members of the referent set
`private String`	`variable` anything preceded by a star or question mark

Constructor Summary

Constructors
Constructor and Description

Referent()

Referent(String s)

Constructors
Constructor and Description
`Referent()`
`Referent(String s)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSetMember(Referent ref)`
`protected void`	`copyFromReferent(Referent ref)`
`String`	`explain()` For debugging purposes to describe what the referent is.
`String`	`getAsVariable(boolean bound)` See the referent as if it were a bound or unbound variable, with prefix ? or *
`String`	`getCardinality()`
`int`	`getCardinalityAsNumber()` Parses the cardinality as a string and returns an integer if one is found.
`String`	`getCgifVariableReference()`
`String`	`getMarker()`
`Double`	`getNumber()`
`String`	`getReferentString()` Return the original string referent as entered by a user or external system.
`String`	`getVariable()` Get the variable portion of a referent, if present.
`private void`	`makeCGIFVariableReference()`
`private void`	`parseReferentString()`
`void`	`setCardinality(String cardinality)`
`void`	`setCgifVariableReference(String cgifVariableReference)`
`void`	`setMarker(String marker)`
`void`	`setMemberList(ArrayList<Referent> members)` Consider a list of referents to be set members.
`void`	`setNumber(Double number)`
`void`	`setReferentString(String ref)` Set the referent original string but do not parse
`void`	`setReferentString(String ref, boolean parse)` Set the referent original string and optionally parse for all possible elements
`void`	`setVariable(String variable)`

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

- Field Detail
  - forall
```
public static final String forall
```
    The forall symbol that can serve as a referent
    
    See Also:
    
    Constant Field Values
  - dist
```
public static final String dist
```
    See Also:
    
    Constant Field Values
  - coll
```
public static final String coll
```
    See Also:
    
    Constant Field Values
  - is
```
private InputStream is
```
  - parser
```
private CGIFParser parser
```
  - asEntered
```
private String asEntered
```
    The referent string as entered (un-edited, un-parsed) by a user or external system.
  - variable
```
private String variable
```
    anything preceded by a star or question mark
  - marker
```
private String marker
```
    If the referent is an actual individual marker
  - cgifVariableReference
```
private String cgifVariableReference
```
    The variable reference for CGIF. Might be a generated name for some generic referents.
  - isASet
```
private boolean isASet
```
    Whether this referent denotes a set or not
  - setMembers
```
private ArrayList<Referent> setMembers
```
    If a set, these are the members of the referent set
  - cardinality
```
private String cardinality
```
    If a set, this is where its cardinality is kept. Note that it may be a string, since it might be of the form { }@M
  - number
```
private Double number
```
    If referent denotes an actual number, here's where it's kept.
- Constructor Detail
  - Referent
```
public Referent()
```
  - Referent
```
public Referent(String s)
```
- Method Detail
  - explain
```
public String explain()
```
    For debugging purposes to describe what the referent is.
  - getReferentString
```
public String getReferentString()
```
    Return the original string referent as entered by a user or external system.
  - setReferentString
```
public void setReferentString(String ref)
```
    Set the referent original string but do not parse
  - setReferentString
```
public void setReferentString(String ref,
                              boolean parse)
```
    Set the referent original string and optionally parse for all possible elements
    
    Parameters:
    
    ref - The referent to be set
    
    parse - Whether to parse it or not (used primarily by the parser itself and this class)
  - getVariable
```
public String getVariable()
```
    Get the variable portion of a referent, if present. Include a leading ? or *
  - getAsVariable
```
public String getAsVariable(boolean bound)
```
    See the referent as if it were a bound or unbound variable, with prefix ? or *
  - setVariable
```
public void setVariable(String variable)
```
  - getCardinality
```
public String getCardinality()
```
  - getCardinalityAsNumber
```
public int getCardinalityAsNumber()
```
    Parses the cardinality as a string and returns an integer if one is found.
    
    Returns:
    
    the integer value of the cardinality string; -1 if not a number.
  - setCardinality
```
public void setCardinality(String cardinality)
```
  - getMarker
```
public String getMarker()
```
  - setMarker
```
public void setMarker(String marker)
```
  - addSetMember
```
public void addSetMember(Referent ref)
```
  - getCgifVariableReference
```
public String getCgifVariableReference()
```
  - setCgifVariableReference
```
public void setCgifVariableReference(String cgifVariableReference)
```
  - getNumber
```
public Double getNumber()
```
  - setNumber
```
public void setNumber(Double number)
```
  - makeCGIFVariableReference
```
private void makeCGIFVariableReference()
```
  - setMemberList
```
public void setMemberList(ArrayList<Referent> members)
```
    Consider a list of referents to be set members.
  - copyFromReferent
```
protected void copyFromReferent(Referent ref)
```
  - parseReferentString
```
private void parseReferentString()
```

Class Referent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

forall

dist

coll

is

parser

asEntered

variable

marker

cgifVariableReference

isASet

setMembers

cardinality

number

Constructor Detail

Referent

Referent

Method Detail

explain

getReferentString

setReferentString

setReferentString

getVariable

getAsVariable

setVariable

getCardinality

getCardinalityAsNumber

setCardinality

getMarker

setMarker

addSetMember

getCgifVariableReference

setCgifVariableReference

getNumber

setNumber

makeCGIFVariableReference

setMemberList

copyFromReferent

parseReferentString