TopologicalLayerModifier (planit-all 0.3.0 API)

All Superinterfaces:

TopologicalModifier

All Known Subinterfaces:

UntypedDirectedGraphLayerModifier<V,E,S>

All Known Implementing Classes:

UntypedNetworkLayerModifierImpl
```
public interface TopologicalLayerModifier
extends TopologicalModifier
```
Interface to define all layer wide modifications functionality to be exposed.

Author:

markr

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`removeDanglingSubnetworks()`	remove any dangling subnetworks from the layer if they exist and subsequently reorder the internal ids if needed
`void`	`removeDanglingSubnetworks(Integer belowSize, Integer aboveSize, boolean alwaysKeepLargest)`	remove any dangling subnetworks below a given size from the network if they exist and subsequently reorder the internal ids if needed

- Method Detail
  - removeDanglingSubnetworks
```
void removeDanglingSubnetworks(Integer belowSize,
                               Integer aboveSize,
                               boolean alwaysKeepLargest)
                        throws PlanItException
```
    remove any dangling subnetworks below a given size from the network if they exist and subsequently reorder the internal ids if needed
    
    Parameters:
    
    belowSize - remove subnetworks below the given size
    
    aboveSize - remove subnetworks above the given size (typically set to maximum value)
    
    alwaysKeepLargest - when true the largest of the subnetworks is always kept, otherwise not
    
    Throws:
    
    PlanItException - thrown if error
  - removeDanglingSubnetworks
```
default void removeDanglingSubnetworks()
                                throws PlanItException
```
    remove any dangling subnetworks from the layer if they exist and subsequently reorder the internal ids if needed
    
    Throws:
    
    PlanItException - thrown if error