java.lang.Object
- com.crawljax.stateabstractions.hybrid.structuralvisualdiff.StructuralVisualDiff

public class StructuralVisualDiff
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`private Set<String>`	`addedNodes`
`private long`	`computationTime`
`private static org.slf4j.Logger`	`LOGGER`
`private Set<String>`	`modifiedNodes`
`private Set<String>`	`movedNodes`
`private Document`	`newDocument`
`private StateVertexForElementsWithVisualInfo`	`newVertex`
`private Map<String,String>`	`nodeMappings`
`private Document`	`oldDocument`
`private StateVertexForElementsWithVisualInfo`	`oldVertex`
`private Set<String>`	`removedNodes`
`private float`	`structuralDistance`

Constructor Summary

Constructors
Modifier	Constructor	Description
`private`	`StructuralVisualDiff(StateVertexForElementsWithVisualInfo oldVertex, StateVertexForElementsWithVisualInfo newVertex)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StructuralVisualDiff`	`calculate(StateVertexForElementsWithVisualInfo oldVertex, StateVertexForElementsWithVisualInfo newVertex)`	Returns a new instance of StructuralVisualDiff which includes the changes across the two given states
`void`	`computeDiff()`
`private void`	`detectNodeModifications()`
`Set<String>`	`getAddedNodes()`
`private AptedNode<StringNodeData>`	`getAPTEDTreeFromDocument(Node node)`
`long`	`getComputationTime()`
`Map<String,String>`	`getMappedNodes()`
`Set<String>`	`getModifiedNodes()`
`Set<String>`	`getMovedNodes()`
`DOMElementWithVisualInfo`	`getNewElementWithVisualInfo(String xpath)`	Given an XPath for a node, this method returns `DOMElementWithVisualInfo` of the node in the new document.
`private String`	`getNodeStringRepresentation(Node node)`
`DOMElementWithVisualInfo`	`getOldElementWithVisualInfo(String xpath)`	Given an XPath for a node, this method returns `DOMElementWithVisualInfo` of the node in the old document.
`Set<String>`	`getRemovedNodes()`
`float`	`getStructuralDistance()`
`private void`	`populatePostorder(List<Node> postorderList, Node node)`
`void`	`serializeDiff(String pathToJSONFile)`
`boolean`	`statesAreIdentical()`	Tells whether two states are identical after performing the analysis.
`String`	`toString()`

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

- Field Detail
  - LOGGER
```
private static final org.slf4j.Logger LOGGER
```
  - nodeMappings
```
private final Map<String,String> nodeMappings
```
  - addedNodes
```
private final Set<String> addedNodes
```
  - removedNodes
```
private final Set<String> removedNodes
```
  - movedNodes
```
private final Set<String> movedNodes
```
  - modifiedNodes
```
private final Set<String> modifiedNodes
```
  - oldVertex
```
private final StateVertexForElementsWithVisualInfo oldVertex
```
  - newVertex
```
private final StateVertexForElementsWithVisualInfo newVertex
```
  - structuralDistance
```
private float structuralDistance
```
  - computationTime
```
private long computationTime
```
  - oldDocument
```
private transient Document oldDocument
```
  - newDocument
```
private transient Document newDocument
```
- Constructor Detail
  - StructuralVisualDiff
```
private StructuralVisualDiff(StateVertexForElementsWithVisualInfo oldVertex,
                             StateVertexForElementsWithVisualInfo newVertex)
```
- Method Detail
  - calculate
```
public static StructuralVisualDiff calculate(StateVertexForElementsWithVisualInfo oldVertex,
                                             StateVertexForElementsWithVisualInfo newVertex)
```
    Returns a new instance of StructuralVisualDiff which includes the changes across the two given states
    
    Parameters:
    
    oldVertex - Old state. Should be of type StateVertexForElementsWithVisualInfo since it relies on the visual information recorded in the previous run of the crawler
    
    newVertex - New state to which we are comparing the old state
    
    Returns:
  - computeDiff
```
public void computeDiff()
```
  - detectNodeModifications
```
private void detectNodeModifications()
```
  - getAPTEDTreeFromDocument
```
private AptedNode<StringNodeData> getAPTEDTreeFromDocument(Node node)
```
  - getNodeStringRepresentation
```
private String getNodeStringRepresentation(Node node)
```
  - populatePostorder
```
private void populatePostorder(List<Node> postorderList,
                               Node node)
```
  - getStructuralDistance
```
public float getStructuralDistance()
```
    Returns:
    
    The distance between the two DOM states based on the APTED algorithm and string cost model
  - getMappedNodes
```
public Map<String,String> getMappedNodes()
```
    Returns:
    
    Nodes mapped across the two DOMs
  - getAddedNodes
```
public Set<String> getAddedNodes()
```
    Returns:
    
    Nodes that have been added to the new DOM
  - getRemovedNodes
```
public Set<String> getRemovedNodes()
```
    Returns:
    
    Nodes that have been removed from the old DOM
  - getMovedNodes
```
public Set<String> getMovedNodes()
```
    Returns:
    
    Nodes (from the old state) that are mapped across the two states but are moved
  - getModifiedNodes
```
public Set<String> getModifiedNodes()
```
    Returns:
    
    Nodes that are modified (visually or textually) from the old state
  - getComputationTime
```
public long getComputationTime()
```
    Returns:
    
    Time took to compute the edit distance in the APTED algorithm
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - statesAreIdentical
```
public boolean statesAreIdentical()
```
    Tells whether two states are identical after performing the analysis. Three things are checked: (1) there is no modified node (visually or textually), (2) there is no moved node, and (3) the distance between the two DOMs' structures is zero (i.e., there is no added/removed nodes and all nodes are mapped without any differences in tag names)
    
    Returns:
    
    True if the states are identical
  - getOldElementWithVisualInfo
```
public DOMElementWithVisualInfo getOldElementWithVisualInfo(String xpath)
```
    Given an XPath for a node, this method returns DOMElementWithVisualInfo of the node in the old document. The XPath should be from the old document.
    
    Parameters:
    
    xpath - of the node
    
    Returns:
    
    The node of type DOMElementWithVisualInfo. null if the node does not exist.
  - getNewElementWithVisualInfo
```
public DOMElementWithVisualInfo getNewElementWithVisualInfo(String xpath)
```
    Given an XPath for a node, this method returns DOMElementWithVisualInfo of the node in the new document. The XPath should be from the new document.
    
    Parameters:
    
    xpath - of the node
    
    Returns:
    
    The node of type DOMElementWithVisualInfo. null if the node does not exist.
  - serializeDiff
```
public void serializeDiff(String pathToJSONFile)
                   throws IOException
```
    Throws:
    
    IOException

Class StructuralVisualDiff

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

nodeMappings

addedNodes

removedNodes

movedNodes

modifiedNodes

oldVertex

newVertex

structuralDistance

computationTime

oldDocument

newDocument

Constructor Detail

StructuralVisualDiff

Method Detail

calculate

computeDiff

detectNodeModifications

getAPTEDTreeFromDocument

getNodeStringRepresentation

populatePostorder

getStructuralDistance

getMappedNodes

getAddedNodes

getRemovedNodes

getMovedNodes

getModifiedNodes

getComputationTime

toString

statesAreIdentical

getOldElementWithVisualInfo

getNewElementWithVisualInfo

serializeDiff