SpringEmbeddedLayoutAlgorithm.java
| Index Score | ||
|---|---|---|
 |
 |
org.jgraph.plugins.layouts |
 |
 |
JGraph |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| LINE_COMMENT | Number of line comments | |
| LOOPS | Number of loops | |
| SIZE | Size of the file in bytes | |
| COMPARISONS | Number of comparison operators | |
| COMMENTS | Comment lines | |
| OPERANDS | Number of operands | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| LOGICAL_LINES | Number of statements | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINES | Number of lines in the source file | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| PARAMS | Number of formal parameter declarations | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| ELOC | Effective lines of code | |
| JAVA0076 | JAVA0076 Use of magic number | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| EXITS | Procedure exits | |
| LOC | Lines of code | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| BLOCKS | Number of blocks | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0084 | JAVA0084 Should use compound assignment operator | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright (c) 2004, Jeremy Jedynak, NetCentric Technology Inc All rights reserved.
*
* Copyright (c) 2004, Sven Luzar All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer. - Redistributions in
* binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution. - Neither the name of JGraph nor
* the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
package org.jgraph.plugins.layouts;
import java.awt.Rectangle;
import java.awt.geom.Rectangle2D;
import java.util.ArrayList;
import java.util.Hashtable;
import java.util.List;
import java.util.Map;
import java.util.Random;
import org.jgraph.JGraph;
import org.jgraph.graph.AttributeMap;
import org.jgraph.graph.CellView;
import org.jgraph.graph.EdgeView;
import org.jgraph.graph.GraphConstants;
import org.jgraph.graph.GraphLayoutCache;
import org.jgraph.graph.PortView;
import org.jgraph.graph.VertexView;
/**
* Arranges the nodes with the Spring Embedded Layout Algorithm. <br>
*
* The algorithm takes O(|V|^2 * |E|) time.
*
* Jeremy Jedynak NetCentric Technology Inc www.NetCentricInc.com
*
* <br>
*
* This layout algorithm is derived from the one written by Sven Luzar. It fixes
* a bug in how the "u" and "v" vectors were stored and retrieved, which
* frequently caused IllegalArgumentExceptions and NullPointerExceptions,
* depending upon your luck.
*
* <br>
*
* Also, the original run method has been broken into several methods. Two new
* constructors and methods were added to support two constraints: the graph
* rendering frame and maxIterations. Most variable names have been modified for
* readability.
*
* <br>
*
* It now properly lays out the graph according to the algorithm. Work still
* needs to be done to better space vertices so that they do not overlap and so
* that edges do not pass through vertices. The new "step" parameter of the run
* method is currently not used. All that being said, this is a good starting
* point to understand the algorithm and make those changes.
*
* <br>
* <br>
*
* @author <a href="mailto:Jeremy.Jedynak@NetCentricInc.com">Jeremy Jedynak </a>
* @author <a href="mailto:Sven.Luzar@web.de">Sven Luzar </a>
* @author <a href="mailto:rmc@telemidia.puc-rio.br">Rogerio Coelho </a>
* @since 1.2.2
* @version 1.1 init
*
* Last Modification : 11/05/2005
* By : Rogerio Coelho <rmc@telemidia.puc-rio.br>
* Description: Now the SpringEmbeddedLayoutAlgorithm is working for group or
* Nested Graph. The other change was in method calculateAttractiveForces
* because have vertices without edges and your power in attractive doesn't
* count.
*
*/
public class SpringEmbeddedLayoutAlgorithm extends JGraphLayoutAlgorithm {
/**
* Key for an attribute. The value for this key is a Rectangle object and
* specifies the disposement.
*/
public static final String SPRING_EMBEDDED_DISP = "SpringEmbeddedDisp";
/**
* Key for an attribute. The value for this key is a Rectangle object and
* specifies the calculated position.
*/
public static final String SPRING_EMBEDDED_POS = "SpringEmbeddedPos";
private Rectangle myFrame = null;
private int myMaxIterations = -1;
public SpringEmbeddedLayoutAlgorithm() {
myFrame = new Rectangle(0, 0, 500, 500); //It's ok 500,500
myMaxIterations = 30; //It's ok 30
}
public SpringEmbeddedLayoutAlgorithm(Rectangle frame, int maxIterations) {
if (frame == null) {
throw new IllegalArgumentException("frame may not be null");
}
if (frame.width <= 0) {
throw new IllegalArgumentException("frame width must be positive");
}
if (frame.height <= 0) {
throw new IllegalArgumentException("frame height must be positive");
} else {
myFrame = frame;
}
if (maxIterations < 0) {
throw new IllegalArgumentException(
"maxIterations must be a positive integer");
} else {
myMaxIterations = maxIterations;
}
}
public void setFrame(Rectangle frame) {
if (frame == null) {
throw new IllegalArgumentException("Frame may not be null");
} else if (frame.width <= 0) {
throw new IllegalArgumentException("frame width must be positive");
} else if (frame.height <= 0) {
throw new IllegalArgumentException("frame height must be positive");
}
myFrame = frame;
}
/**
* Returns the name of this algorithm in human readable form.
*/
public String toString() {
return "Spring Embedded";
}
public void setMaxIterations(int maxIterations) {
if (maxIterations < 0) {
throw new IllegalArgumentException(
"maxIterations must be a positive integer");
}
myMaxIterations = maxIterations;
}
/**
* Replace all cells inside the frame because have cells with valeu negative
* for x and y
*
* @param vertices :
* list all vertices
* @param frameRectangle :
* Rectangle where x and y have the minX and minY the all cells
* in the graph.
*/
private void replaceInsideFrame(List vertices, Rectangle2D frameRectangle) {
for (int i = 0; i < vertices.size(); i++) {
VertexView vertex = (VertexView) vertices.get(i);
Rectangle2D vPos = getVertexPosition(vertex, SPRING_EMBEDDED_POS);
Rectangle2D newRandomPosition = new Rectangle2D.Double(vPos.getX()
- frameRectangle.getX(), vPos.getY()
- frameRectangle.getY(), vPos.getWidth(), vPos.getHeight());
updateVertexPosition(vertex, SPRING_EMBEDDED_POS, newRandomPosition);
}
}
/**
* The implementation of the layout algorithm.
*
* @param graph :
* JGraph instance
* @param dynamic_cells :
* List of all nodes the layout should move
* @param static_cells :
* List of node the layout should not move but allow for
*/
public void run(JGraph graph, Object[] dynamic_cells, Object[] static_cells) {
// ---------------------------------------------------------------------------
// initial work
// ---------------------------------------------------------------------------
GraphLayoutCache layoutCache = graph.getGraphLayoutCache();
List vertices = new ArrayList(); // vertices
List edges = new ArrayList(); // Edges
List verticesWithOutEdges = new ArrayList();
//Take all cells
CellView[] cellviews = layoutCache.getMapping(dynamic_cells, false);
//System.out.println("Number of Cells = " + cellviews.length);
partitionCells(cellviews, vertices, edges);
//System.out.println("Number of vertices = " + vertices.size());
//System.out.println("Number of Edges = " + edges.size());
double FrameWidth = myFrame.getWidth(); //Width of the selectionFrame
double FrameHeight = myFrame.getHeight(); //Height of the
//selectionFrame
double FrameArea = FrameWidth * FrameHeight; //area of the
//selectionFrame
/*
* System.out.println( " W = " + FrameWidth ) ; System.out.println( " H = " +
* FrameHeight ) ; System.out.println( " Area = " + FrameArea ) ;
*/
randomizeVertexPositions(vertices);
// ---------------------------------------------------------------------------
// start the iterations
// ---------------------------------------------------------------------------
// calculate the field length for the area
double AreaFieldLength = Math.sqrt((FrameArea) / (vertices.size()));
verticesWithOutEdges = findVertexWithoutEdges(edges, vertices);
for (int loop = 0; loop < myMaxIterations; loop++) {
calculateRepulsiveForces(vertices, AreaFieldLength);
calculateAttractiveForces(edges, verticesWithOutEdges,
AreaFieldLength);
calculateNewPositions(vertices, loop);
}
//calculate the stretch factor and the movement factor
//to fit the calculated frame to the selected Frame
Rectangle2D calculateFrame = calculateNewFrame(vertices);
replaceInsideFrame(vertices, calculateFrame);
calculateFrame.setFrame(0, 0, 900, 900);//this is necessary because
// the frame have w=500 and h=500
double stretchX = (myFrame.width) / (calculateFrame.getWidth());
double stretchY = (myFrame.height) / (calculateFrame.getHeight());
int movementX = (int) (myFrame.x - calculateFrame.getX());
int movementY = (int) (myFrame.y - calculateFrame.getY());
Map viewMap = drawGraph(layoutCache.getMapping(dynamic_cells, false),
movementX, stretchX, movementY, stretchY);
layoutCache.edit(viewMap, null, null, null);
}
private void partitionCells(CellView[] cells, List vertices, List edges) {
// Partition the list of cells into list of vertices and list of edges
for (int loop = 0; loop < cells.length; loop++) {
CellView cell = cells[loop];
if (cell == null) {
// Skip over null cells
continue;
} else if (cell instanceof EdgeView) {
EdgeView edge = (EdgeView) cell;
edges.add(edge);
} else if (cell instanceof VertexView) {
VertexView vertex = (VertexView) cell;
vertices.add(vertex);
}
}
}
private void randomizeVertexPositions(List vertices) {
int vertW, vertH, frameW, frameH, newX, newY = 0;
Rectangle newRandomPosition = null;
// Fill the initial positions with random positions
Random random = new Random();
for (int loop = 0; loop < vertices.size(); loop++) {
VertexView vertex = (VertexView) vertices.get(loop);
vertW = (int) vertex.getBounds().getWidth();
vertH = (int) vertex.getBounds().getHeight();
frameW = myFrame.width;
frameH = myFrame.height;
newX = random.nextInt(frameW);
//Verify if newX is out of MyFrame
while (newX < 0) {
newX = random.nextInt(frameW);
}
newY = random.nextInt(frameH);
//Verify if newY is out of MyFrame
while (newY < 0) {
newY = random.nextInt(frameW);
}
//System.out.println("Vertex = " + vertex.getCell().toString() + "
// x = " + newX + " y = " + newY + " w = " + vertW + " h = "
// +vertH);
newRandomPosition = new Rectangle(newX, newY, vertW, vertH);
updateVertexPosition(vertex, SPRING_EMBEDDED_POS, newRandomPosition);
}
}
private void calculateRepulsiveForces(List vertices, double AreaFieldLength) {
// ---------------------------------------------------------------------------
// calculate the repulsive forces
// ---------------------------------------------------------------------------
// calculate the repulsive forces
for (int vCount = 0; vCount < vertices.size(); vCount++) {
VertexView v = (VertexView) vertices.get(vCount);
Rectangle2D vPos = getVertexPosition(v, SPRING_EMBEDDED_POS);
//System.out.println( "vertex " + loop + " get: vPos = " + vPos ) ;
//Each vertex has two vectors: pos and disp
Rectangle vDisp = new Rectangle(0, 0);
for (int uCount = 0; uCount < vertices.size(); uCount++) {
VertexView u = (VertexView) vertices.get(uCount);
if (u != v) {
// delta is short hand for the difference
// vector between the positions of the two vertices
Rectangle2D uPos = getVertexPosition(u, SPRING_EMBEDDED_POS);
// System.out.println( "vertex " + uCount + " get: uPos = "
// + uPos ) ;
Rectangle delta = new Rectangle();
delta.x = (int) (vPos.getX() - uPos.getX());
delta.y = (int) (vPos.getY() - uPos.getY());
double fr = fr(norm(delta), AreaFieldLength);
//System.out.println("FR = " + fr);
//fr = fr - fr*0.20;
//System.out.println("FR = " + fr);
double deltaNormX = delta.x / norm(delta);
double dispX = deltaNormX * fr;
double deltaNormY = delta.y / norm(delta);
double dispY = deltaNormY * fr;
vDisp.x = vDisp.x + (int) dispX;
vDisp.y = vDisp.y + (int) dispY;
}
}
updateVertexPosition(v, SPRING_EMBEDDED_DISP, vDisp);
}
}
private void calculateAttractiveForces(List edges,
List verticesWithoutEdges, double AreaFieldLength) {
// ---------------------------------------------------------------------------
// calculate the attractive forces
// ---------------------------------------------------------------------------
double dispX = 0, dispY = 0;
EdgeView e = null;
//Verify if have edges
if (edges.size() == 0) {
return;
}
for (int cellCount = 0; cellCount < edges.size(); cellCount++) {
e = (EdgeView) edges.get(cellCount);
if (e.getSource() != null && e.getTarget() != null
&& e.getSource() != e.getTarget()) {
// extract the used fields
CellView v = ((PortView) e.getSource()).getParentView();
CellView u = ((PortView) e.getTarget()).getParentView();
//Source and Target equal
if (v == u) {
continue;
}
Rectangle2D vPos = getVertexPosition(v, SPRING_EMBEDDED_POS);
Rectangle2D uPos = getVertexPosition(u, SPRING_EMBEDDED_POS);
// System.out.println( "vertex get: vPos = " + vPos ) ;
// System.out.println( "vertex get: uPos = " + uPos ) ;
if (vPos == null || uPos == null) {
continue;
}
Rectangle2D vDisp = getVertexPosition(v, SPRING_EMBEDDED_DISP);
Rectangle2D uDisp = getVertexPosition(u, SPRING_EMBEDDED_DISP);
// System.out.println( "vertex get: vDisp = " + vDisp ) ;
// System.out.println( "vertex get: uDisp = " + uDisp ) ;
if (vDisp == null || uDisp == null) {
continue;
}
// calculate the delta
Rectangle delta = new Rectangle();
delta.x = (int) (vPos.getX() - uPos.getX());
delta.y = (int) (vPos.getY() - uPos.getY());
// calculate the attractive forces
double fa = fa(norm(delta), AreaFieldLength);
//System.out.println("FA = " + fa);
double deltaNormX = delta.x / norm(delta);
double deltaNormY = delta.y / norm(delta);
dispX = deltaNormX * fa;
dispY = deltaNormY * fa;
vDisp.setFrame(vDisp.getX() - dispX, vDisp.getY() - dispY,
vDisp.getWidth(), vDisp.getHeight());
uDisp.setFrame(uDisp.getX() + dispX, uDisp.getY() + dispY,
uDisp.getWidth(), uDisp.getHeight());
//System.out.println( "Cell update: vDisp = " +
// v.getCell().toString() + " rec = " + vDisp ) ;
//System.out.println( "Cell update: uDisp = " +
// u.getCell().toString() + " rec = " + uDisp ) ;
// store the new values
updateVertexPosition(v, SPRING_EMBEDDED_DISP, vDisp);
updateVertexPosition(u, SPRING_EMBEDDED_DISP, uDisp);
}
}
//vertices without edges
for (int cellCount = 0; cellCount < verticesWithoutEdges.size(); cellCount++) {
VertexView vertex = (VertexView) verticesWithoutEdges
.get(cellCount);
int vertW = (int) vertex.getBounds().getWidth();
int vertH = (int) vertex.getBounds().getHeight();
Rectangle newRandomPosition = null;
// Fill the initial positions with random positions
Random random = new Random();
//Take the new position inside the Frame
int newX = random.nextInt(500);
//Verify if newX is outSide of MyFrame
while (newX < 0) {
newX = random.nextInt((int) vertex.getBounds().getCenterX());
}
//Take the new position inside the Frame
int newY = random.nextInt(500);
//Verify if newY is outSide of MyFrame
while (newY < 0) {
newY = random.nextInt((int) vertex.getBounds().getCenterY());
}
//System.out.println("Vertex = " + vertex.getCell().toString() + "
// x = " + newX + " y = " + newY + " w = " + vertW + " h = "
// +vertH);
newRandomPosition = new Rectangle(newX, newY, vertW, vertH);
updateVertexPosition(vertex, SPRING_EMBEDDED_POS, newRandomPosition);
}
}
/**
* Take all vertices without edges and put in List vertexWithoutEdges.
* @param edges : List the all edges
* @param vertices : List the all vertices
* @return vertexWithoutEdges : List of vertices without edge
*/
private List findVertexWithoutEdges(List edges, List vertices) {
List vertexWithoutEdges = new ArrayList();
//Load all vertices
for (int i = 0; i < vertices.size(); i++) {
vertexWithoutEdges.add(vertices.get(i));
}
//Remove all vertices of edges
for (int i = 0; i < edges.size(); i++) {
EdgeView e = (EdgeView) edges.get(i);
CellView source = e.getSource().getParentView();
CellView target = e.getTarget().getParentView();
vertexWithoutEdges.remove(source);
vertexWithoutEdges.remove(target);
}
return vertexWithoutEdges;
}
private void calculateNewPositions(List vertices, int curIteration) {
// ---------------------------------------------------------------------------
// calculate the new positions
// ---------------------------------------------------------------------------
// limit the maximum displacement to the temperature buttonText
// and then prevent from being displacement outside frame
double Temperature = Math.sqrt(Math.pow(myFrame.width, 2)
+ Math.pow(myFrame.height, 2))
* ((((double) myMaxIterations) / ((curIteration + 1))) / (myMaxIterations));
for (int vCount = 0; vCount < vertices.size(); vCount++) {
VertexView v = (VertexView) vertices.get(vCount);
Rectangle2D vDisp = getVertexPosition(v, SPRING_EMBEDDED_DISP);
Rectangle2D vPos = getVertexPosition(v, SPRING_EMBEDDED_POS);
//System.out.println( "vertex " + v.toString() + "get: vDisp = " +
// vDisp ) ;
//System.out.println( "vertex " + v.toString() + "get: vDisp = " +
// vPos ) ;
double dispNormX = vDisp.getX() / norm(vDisp);
double minX = Math.min(Math.abs(vDisp.getX()), Temperature);
double dispNormY = vDisp.getY() / norm(vDisp);
double minY = Math.min(Math.abs(vDisp.getY()), Temperature);
vPos.setFrame(vPos.getX() + dispNormX * minX, vPos.getY()
+ dispNormY * minY, vPos.getWidth(), vPos.getHeight());
/*
* double maxX = Math.max(-W / 2, vPos.x); double maxY = Math.max(-L /
* 2, vPos.y); double minX2 = Math.min(W / 2, maxX); double minY2 =
* Math.min(L / 2, maxY); vPos.x = (int)minX2; vPos.y = (int)minY2;
*/
// System.out.println( "cell update: vPos = " + vPos ) ;
updateVertexPosition(v, SPRING_EMBEDDED_POS, vPos);
}
}
private Rectangle2D calculateNewFrame(List vertices) {
double x = 0, y = 0, w = 0, h = 0;
// find the new positions for the
// calculated frame
Rectangle2D calculatedFrame = new Rectangle2D.Double();
for (int vCount = 0; vCount < vertices.size(); vCount++) {
VertexView v = (VertexView) vertices.get(vCount);
Rectangle2D vPos = getVertexPosition(v, SPRING_EMBEDDED_POS);
//System.out.println( "vertex get: vPos = " + vPos ) ;
x = calculatedFrame.getX();
y = calculatedFrame.getY();
w = calculatedFrame.getWidth();
h = calculatedFrame.getHeight();
if (vPos.getX() < calculatedFrame.getX()) {
x = vPos.getX();
}
if (vPos.getY() < calculatedFrame.getY()) {
y = vPos.getY();
}
double width = vPos.getX() - calculatedFrame.getX();
if (width > calculatedFrame.getWidth()) {
w = width;
}
double height = vPos.getY() - calculatedFrame.getY();
if (height > calculatedFrame.getHeight()) {
h = height;
}
//System.out.println( "vertex =" + v.getCell());
//System.out.println("x = " + x + " y = " + y + " w = " + w + " h =
// " + h);
calculatedFrame.setFrame(x, y, w, h);
}
return (calculatedFrame);
}
private Map drawGraph(CellView[] cells, int movementX,
double stretchX, int movementY, double stretchY) {
// ---------------------------------------------------------------------------
// draw the graph
// ---------------------------------------------------------------------------
Map viewMap = new Hashtable();
for (int loop = 0; loop < cells.length; loop++) {
CellView cell = cells[loop];
if (cell == null) {
continue;
} else if (cell instanceof EdgeView) {
cell.update();
} else if (cell instanceof VertexView) {
// get the current view object
VertexView vertex = (VertexView) cell;
// remove the temp objects
Rectangle2D newPosition = removeVertexPosition(vertex,
SPRING_EMBEDDED_POS);
removeVertexPosition(vertex, SPRING_EMBEDDED_DISP);
//System.out.println( "vertex" + vertex.getCell() + "children =
// " + vertex.getChildViews().length+ " newPosition = " +
// newPosition);
// update the location to get the correct
newPosition.setFrame((newPosition.getX() + movementX)
* stretchX,
(newPosition.getY() + movementY) * stretchY,
newPosition.getWidth(), newPosition.getHeight());
// update the view
AttributeMap vertAttrib = new AttributeMap();
GraphConstants.setBounds(vertAttrib, newPosition);
vertex.changeAttributes(vertAttrib);
// The statement above fixes a bug in the original code
viewMap.put(cells[loop], vertAttrib);
}
}
return (viewMap);
}
private void updateVertexPosition(CellView vert, String PosField,
Rectangle2D Position) {
AttributeMap vertAttrib = vert.getAllAttributes();
vertAttrib.put(PosField, Position);
/*
* There is no contractual guarantee that the Attribute Map returned by
* CellView.getAllAttributes() or (especially) CellView.getAttributes()
* is the same Attribute Map stored within the VertexView, so a
* seemingly redundant call to CellView.setAttributes msut be made
* below. This fixes a bug in the original code.
*/
vert.changeAttributes(vertAttrib);
}
private Rectangle2D getVertexPosition(CellView vert, String PosField) {
AttributeMap vertAttrib = vert.getAllAttributes();
Rectangle2D result = (Rectangle2D) vertAttrib.get(PosField);
return (result);
}
private Rectangle2D removeVertexPosition(CellView vert, String PosField) {
AttributeMap vertAttrib = vert.getAllAttributes();
Rectangle2D result = (Rectangle2D) vertAttrib.remove(PosField);
/*
* There is no contractual guarantee that the Attribute Map returned by
* CellView.getAllAttributes() or (especially) CellView.getAttributes()
* is the same Attribute Map stored within the VertexView, so a
* seemingly redundant call to CellView.setAttributes msut be made
* below. This fixes a bug in the original code.
*/
vert.changeAttributes(vertAttrib);
return (result);
}
/**
* calculates the attractive forces
*/
protected double fa(double x, double k) {
double force = (x * x / k);
return force;
}
/**
* calculates the repulsive forces
*/
protected double fr(double x, double k) {
double force = (k * k) / x;
return force;
}
/**
* Calculates the euklidische Norm for the point p.
*
*/
protected double norm(Rectangle2D p) {
double x = p.getX();
double y = p.getY();
double norm = Math.sqrt(x * x + y * y);
return norm;
}
}
The table below shows all metrics for SpringEmbeddedLayoutAlgorithm.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 64.00 | Number of blocks | |
| BLOCK_COMMENT | 52.00 | Number of block comment lines | |
| COMMENTS | 238.00 | Comment lines | |
| COMMENT_DENSITY | 0.83 | Comment density | |
| COMPARISONS | 81.00 | Number of comparison operators | |
| CYCLOMATIC | 66.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 11.00 | Comments in declarations | |
| DOC_COMMENT | 93.00 | Number of javadoc comment lines | |
| ELOC | 286.00 | Effective lines of code | |
| EXEC_COMMENTS | 62.00 | Comments in executable code | |
| EXITS | 50.00 | Procedure exits | |
| FUNCTIONS | 21.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 90.85 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 70.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 1.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 6.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 2.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 5.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 4.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 4.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 5.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 5.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 2.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 714.00 | Number of lines in the source file | |
| LINE_COMMENT | 93.00 | Number of line comments | |
| LOC | 342.00 | Lines of code | |
| LOGICAL_LINES | 226.00 | Number of statements | |
| LOOPS | 17.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1066.00 | Number of operands | |
| OPERATORS | 1875.00 | Number of operators | |
| PARAMS | 40.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2941.00 | Halstead program length | |
| PROGRAM_VOCAB | 309.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 30.00 | Number of return points from functions | |
| SIZE | 27358.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 264.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 45.00 | Number of unique operators | |
| WHITESPACE | 134.00 | Number of whitespace lines | |