Path (CharGer4 Documentation)

Object
- cgfca.Path

```
public class Path
extends Object
```
A path consists of a sequence of one or more Concepts and Relations. If there is a cycle, then the beginning concept is repeated at the end of the path.

Author:

Harry S. Delugach (delugach@uah.edu)

Field Summary

Fields
Modifier and Type Field and Description

(package private) ArrayList<GNode> path

Fields
Modifier and Type	Field and Description
`(package private) ArrayList<GNode>`	`path`

Constructor Summary

Constructors
Constructor and Description

Path()

Constructors
Constructor and Description
`Path()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToPath(BinaryTuple bt)`
`void`	`addToPath(Concept c)` Add the concept to the end of the path.
`Path`	`clone()`
`boolean`	`contains(Concept concept)`
`boolean`	`cycleSame(Path otherPath)` Determine whether this path is equivalent to the given path if they are cycles.
`boolean`	`equals(Path otherPath)` Compares two paths for equality as follows.
`GNode`	`firstNode()`
`boolean`	`isCycle()`
`boolean`	`isEmpty()`
`boolean`	`isPathBetweenTerminals()`
`GNode`	`lastNode()`
`int`	`length()` How many concepts and relations are in the path.
`String`	`toString()` Show the path as a string of the form `"Cat - sits-on - Mat - has-attribute - Colour: Grey`

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

- Field Detail
  - path
```
ArrayList<GNode> path
```
- Constructor Detail
  - Path
```
public Path()
```
- Method Detail
  - contains
```
public boolean contains(Concept concept)
```
  - addToPath
```
public void addToPath(Concept c)
```
    Add the concept to the end of the path.
    
    Parameters:
    
    c - concept to be added.
  - addToPath
```
public void addToPath(BinaryTuple bt)
```
  - isEmpty
```
public boolean isEmpty()
```
  - firstNode
```
public GNode firstNode()
```
  - lastNode
```
public GNode lastNode()
```
  - isCycle
```
public boolean isCycle()
```
  - clone
```
public Path clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Show the path as a string of the form "Cat - sits-on - Mat - has-attribute - Colour: Grey
    
    Overrides:
    
    toString in class Object
    
    Returns:
  - length
```
public int length()
```
    How many concepts and relations are in the path. If it's a cycle, then the first and last nodes (which are identical) are both counted.
    
    Returns:
    
    number of concepts and relations in the path
  - isPathBetweenTerminals
```
public boolean isPathBetweenTerminals()
```
  - equals
```
public boolean equals(Path otherPath)
```
    Compares two paths for equality as follows. If either path is empty, then they're not equal. If the two paths are the same length and contain the same objects (in the == sense), then the paths are equal. If one path is the exact reverse of the other path, then they are equal. Otherwise false.
    
    Parameters:
    
    otherPath -
    
    Returns:
  - cycleSame
```
public boolean cycleSame(Path otherPath)
```
    Determine whether this path is equivalent to the given path if they are cycles. If either is not a cycle, return false. Otherwise walk the path to see if they're equivalent
    
    Parameters:
    
    otherPath -
    
    Returns:

Class Path

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

path

Constructor Detail

Path

Method Detail

contains

addToPath

addToPath

isEmpty

firstNode

lastNode

isCycle

clone

toString

length

isPathBetweenTerminals

equals

cycleSame