Remove junk from BOM (eyelets, wires, traces)

2026-11-11 01:32:08 +10:00 · 2012-08-16 15:50:59 +00:00
parent 237639b9a1
commit ccc90dd3a6
18 changed files with 62 additions and 26 deletions
@@ -3,9 +3,10 @@ package org.diylc.components.boards;
 import java.awt.Graphics2D;

 import org.diylc.core.IDIYComponent;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;

-@ComponentDescriptor(name = "Blank Board", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Blank circuit board")
+@ComponentDescriptor(name = "Blank Board", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Blank circuit board", bomPolicy = BomPolicy.SHOW_ONLY_TYPE_NAME)
 public class BlankBoard extends AbstractBoard {

 	private static final long serialVersionUID = 1L;
@@ -10,13 +10,14 @@ import org.diylc.core.ComponentState;
 import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;
 import org.diylc.utils.Constants;

-@ComponentDescriptor(name = "Eyelet Board", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Perforated board with eyelets")
+@ComponentDescriptor(name = "Eyelet Board", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Perforated board with eyelets", bomPolicy = BomPolicy.SHOW_ONLY_TYPE_NAME)
 public class EyeletBoard extends AbstractBoard {

 	private static final long serialVersionUID = 1L;
@@ -10,13 +10,14 @@ import org.diylc.core.ComponentState;
 import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;
 import org.diylc.utils.Constants;

-@ComponentDescriptor(name = "Marshall Style Perf Board", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Perforated board as found on some Marshall and Trainwreck amps")
+@ComponentDescriptor(name = "Marshall Style Perf Board", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Perforated board as found on some Marshall and Trainwreck amps", bomPolicy = BomPolicy.SHOW_ONLY_TYPE_NAME)
 public class MarshallPerfBoard extends AbstractBoard {

 	private static final long serialVersionUID = 1L;
@@ -10,13 +10,14 @@ import org.diylc.core.ComponentState;
 import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;
 import org.diylc.utils.Constants;

-@ComponentDescriptor(name = "Perf Board w/ Pads", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Perforated board with solder pads")
+@ComponentDescriptor(name = "Perf Board w/ Pads", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Perforated board with solder pads", bomPolicy = BomPolicy.SHOW_ONLY_TYPE_NAME)
 public class PerfBoard extends AbstractBoard {

 	private static final long serialVersionUID = 1L;
@@ -12,13 +12,14 @@ import org.diylc.core.ComponentState;
 import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;
 import org.diylc.utils.Constants;

-@ComponentDescriptor(name = "Vero Board", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Perforated FR4 board with copper strips connecting all holes in a row")
+@ComponentDescriptor(name = "Vero Board", category = "Boards", author = "Branislav Stojkovic", zOrder = IDIYComponent.BOARD, instanceNamePrefix = "Board", description = "Perforated FR4 board with copper strips connecting all holes in a row", bomPolicy = BomPolicy.SHOW_ONLY_TYPE_NAME)
 public class VeroBoard extends AbstractBoard {

 	private static final long serialVersionUID = 1L;
@@ -10,12 +10,13 @@ import org.diylc.core.ComponentState;
 import org.diylc.core.CreationMethod;
 import org.diylc.core.IDIYComponent;
 import org.diylc.core.VisibilityPolicy;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;

-@ComponentDescriptor(name = "Copper Trace", author = "Branislav Stojkovic", category = "Connectivity", creationMethod = CreationMethod.POINT_BY_POINT, instanceNamePrefix = "Trace", description = "Straight copper trace", zOrder = IDIYComponent.TRACE)
+@ComponentDescriptor(name = "Copper Trace", author = "Branislav Stojkovic", category = "Connectivity", creationMethod = CreationMethod.POINT_BY_POINT, instanceNamePrefix = "Trace", description = "Straight copper trace", zOrder = IDIYComponent.TRACE, bomPolicy = BomPolicy.NEVER_SHOW)
 public class CopperTrace extends AbstractLeadedComponent<Void> {

 	private static final long serialVersionUID = 1L;
@@ -8,12 +8,13 @@ import org.diylc.common.ObjectCache;
 import org.diylc.components.AbstractCurvedComponent;
 import org.diylc.core.ComponentState;
 import org.diylc.core.IDIYComponent;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;

-@ComponentDescriptor(name = "Curved Trace", author = "Branislav Stojkovic", category = "Connectivity", instanceNamePrefix = "Trace", description = "Curved copper trace with two control points", zOrder = IDIYComponent.TRACE)
+@ComponentDescriptor(name = "Curved Trace", author = "Branislav Stojkovic", category = "Connectivity", instanceNamePrefix = "Trace", description = "Curved copper trace with two control points", zOrder = IDIYComponent.TRACE, bomPolicy = BomPolicy.NEVER_SHOW)
 public class CurvedTrace extends AbstractCurvedComponent<Void> {

 	private static final long serialVersionUID = 1L;
@@ -10,13 +10,14 @@ import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
 import org.diylc.core.VisibilityPolicy;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;
 import org.diylc.utils.Constants;

-@ComponentDescriptor(name = "Eyelet", category = "Connectivity", author = "Branislav Stojkovic", description = "Eyelet or turret terminal", instanceNamePrefix = "Eyelet", stretchable = false, zOrder = IDIYComponent.TRACE + 0.1)
+@ComponentDescriptor(name = "Eyelet", category = "Connectivity", author = "Branislav Stojkovic", description = "Eyelet or turret terminal", instanceNamePrefix = "Eyelet", stretchable = false, zOrder = IDIYComponent.TRACE + 0.1, bomPolicy = BomPolicy.SHOW_ONLY_TYPE_NAME)
 public class Eyelet extends AbstractComponent<String> {

 	private static final long serialVersionUID = 1L;
@@ -8,11 +8,12 @@ import org.diylc.common.ObjectCache;
 import org.diylc.components.AbstractCurvedComponent;
 import org.diylc.core.ComponentState;
 import org.diylc.core.IDIYComponent;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.utils.Constants;

-@ComponentDescriptor(name = "Hookup Wire", author = "Branislav Stojkovic", category = "Connectivity", instanceNamePrefix = "W", description = "Flexible wire with two control points", zOrder = IDIYComponent.COMPONENT)
+@ComponentDescriptor(name = "Hookup Wire", author = "Branislav Stojkovic", category = "Connectivity", instanceNamePrefix = "W", description = "Flexible wire with two control points", zOrder = IDIYComponent.COMPONENT, bomPolicy = BomPolicy.NEVER_SHOW)
 public class HookupWire extends AbstractCurvedComponent<Void> {

 	private static final long serialVersionUID = 1L;
@@ -28,17 +29,21 @@ public class HookupWire extends AbstractCurvedComponent<Void> {
 	}

 	@Override
-	protected void drawCurve(CubicCurve2D curve, Graphics2D g2d, ComponentState componentState) {
-		int thickness = (int) (Math.pow(Math.E, -1.12436 - 0.11594 * gauge.getValue())
+	protected void drawCurve(CubicCurve2D curve, Graphics2D g2d,
+			ComponentState componentState) {
+		int thickness = (int) (Math.pow(Math.E, -1.12436 - 0.11594
+				* gauge.getValue())
 				* Constants.PIXELS_PER_INCH * (1 + 2 * INSULATION_THICKNESS_PCT));
 		Color curveColor = componentState == ComponentState.SELECTED
-				|| componentState == ComponentState.DRAGGING ? SELECTION_COLOR : color.darker();
+				|| componentState == ComponentState.DRAGGING ? SELECTION_COLOR
+				: color.darker();
 		g2d.setColor(curveColor);
 		g2d.setStroke(ObjectCache.getInstance().fetchBasicStroke(thickness));
 		g2d.draw(curve);
 		if (componentState == ComponentState.NORMAL) {
 			g2d.setColor(color);
-			g2d.setStroke(ObjectCache.getInstance().fetchBasicStroke(thickness - 2));
+			g2d.setStroke(ObjectCache.getInstance().fetchBasicStroke(
+					thickness - 2));
 			g2d.draw(curve);
 		}
 	}
@@ -9,11 +9,12 @@ import org.diylc.components.AbstractLeadedComponent;
 import org.diylc.core.ComponentState;
 import org.diylc.core.CreationMethod;
 import org.diylc.core.IDIYComponent;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;

-@ComponentDescriptor(name = "Jumper", author = "Branislav Stojkovic", category = "Connectivity", creationMethod = CreationMethod.POINT_BY_POINT, instanceNamePrefix = "J", description = "", zOrder = IDIYComponent.COMPONENT)
+@ComponentDescriptor(name = "Jumper", author = "Branislav Stojkovic", category = "Connectivity", creationMethod = CreationMethod.POINT_BY_POINT, instanceNamePrefix = "J", description = "", zOrder = IDIYComponent.COMPONENT, bomPolicy = BomPolicy.NEVER_SHOW)
 public class Jumper extends AbstractLeadedComponent<Void> {

 	private static final long serialVersionUID = 1L;
@@ -11,11 +11,12 @@ import org.diylc.core.CreationMethod;
 import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;

-@ComponentDescriptor(name = "Line", author = "Branislav Stojkovic", category = "Connectivity", creationMethod = CreationMethod.POINT_BY_POINT, instanceNamePrefix = "LN", description = "", zOrder = IDIYComponent.COMPONENT)
+@ComponentDescriptor(name = "Line", author = "Branislav Stojkovic", category = "Connectivity", creationMethod = CreationMethod.POINT_BY_POINT, instanceNamePrefix = "LN", description = "", zOrder = IDIYComponent.COMPONENT, bomPolicy = BomPolicy.NEVER_SHOW)
 public class Line extends AbstractLeadedComponent<Void> {

 	private static final long serialVersionUID = 1L;
@@ -10,13 +10,14 @@ import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
 import org.diylc.core.VisibilityPolicy;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;
 import org.diylc.utils.Constants;

-@ComponentDescriptor(name = "Solder Pad", category = "Connectivity", author = "Branislav Stojkovic", description = "test", instanceNamePrefix = "Pad", stretchable = false, zOrder = IDIYComponent.TRACE + 0.1)
+@ComponentDescriptor(name = "Solder Pad", category = "Connectivity", author = "Branislav Stojkovic", description = "test", instanceNamePrefix = "Pad", stretchable = false, zOrder = IDIYComponent.TRACE + 0.1, bomPolicy = BomPolicy.NEVER_SHOW)
 public class SolderPad extends AbstractComponent<Void> {

 	private static final long serialVersionUID = 1L;
@@ -11,12 +11,13 @@ import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
 import org.diylc.core.VisibilityPolicy;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;

-@ComponentDescriptor(name = "Trace Cut", category = "Connectivity", author = "Branislav Stojkovic", description = "Designates the place where a trace on the vero board needs to be cut", instanceNamePrefix = "Cut", stretchable = false, zOrder = IDIYComponent.BOARD + 1)
+@ComponentDescriptor(name = "Trace Cut", category = "Connectivity", author = "Branislav Stojkovic", description = "Designates the place where a trace on the vero board needs to be cut", instanceNamePrefix = "Cut", stretchable = false, zOrder = IDIYComponent.BOARD + 1, bomPolicy = BomPolicy.NEVER_SHOW)
 public class TraceCut extends AbstractComponent<Void> {

 	private static final long serialVersionUID = 1L;
@@ -15,6 +15,7 @@ import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
 import org.diylc.core.VisibilityPolicy;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
@@ -22,7 +23,7 @@ import org.diylc.core.measures.SizeUnit;
 import org.diylc.utils.BomEntry;
 import org.diylc.utils.BomMaker;

-@ComponentDescriptor(name = "Bill of Materials", author = "Branislav Stojkovic", category = "Misc", description = "", instanceNamePrefix = "BOM", zOrder = IDIYComponent.TEXT, stretchable = false)
+@ComponentDescriptor(name = "Bill of Materials", author = "Branislav Stojkovic", category = "Misc", description = "", instanceNamePrefix = "BOM", zOrder = IDIYComponent.TEXT, stretchable = false, bomPolicy = BomPolicy.NEVER_SHOW)
 public class BOM extends AbstractComponent<Void> {

 	public static Size DEFAULT_SIZE = new Size(10d, SizeUnit.cm);
@@ -49,14 +50,20 @@ public class BOM extends AbstractComponent<Void> {
 		}
 		g2d.setFont(LABEL_FONT);
 		g2d.setColor(componentState == ComponentState.DRAGGING
-				|| componentState == ComponentState.SELECTED ? SELECTION_COLOR : COLOR);
+				|| componentState == ComponentState.SELECTED ? SELECTION_COLOR : COLOR);		
 		// Determine maximum name length and maximum value length to calculate
-		// number of columns.
+		// number of columns.		
 		FontMetrics fontMetrics = g2d.getFontMetrics();
 		int maxNameWidth = 0;
 		int maxValueWidth = 0;
 		int maxHeight = 0;
 		for (BomEntry entry : bom) {
+			String valueStr;
+			if (entry.getValue() == null || entry.getValue().trim().isEmpty()) {
+				valueStr = "qty " + entry.getQuantity().toString();
+			} else {
+				valueStr = entry.getValue().toString();
+			}
 			Rectangle2D stringBounds = fontMetrics.getStringBounds(entry.getName(), g2d);
 			if (stringBounds.getWidth() > maxNameWidth) {
 				maxNameWidth = (int) stringBounds.getWidth();
@@ -64,7 +71,7 @@ public class BOM extends AbstractComponent<Void> {
 			if (stringBounds.getHeight() > maxHeight) {
 				maxHeight = (int) stringBounds.getHeight();
 			}
-			stringBounds = fontMetrics.getStringBounds(entry.getValue().toString(), g2d);
+			stringBounds = fontMetrics.getStringBounds(valueStr, g2d);
 			if (stringBounds.getWidth() > maxValueWidth) {
 				maxValueWidth = (int) stringBounds.getWidth();
 			}
@@ -75,6 +82,8 @@ public class BOM extends AbstractComponent<Void> {
 		// Calculate maximum entry size.
 		int maxEntrySize = maxNameWidth + maxValueWidth + 2 * (int) SPACING.convertToPixels();
 		int columnCount = (int) size.convertToPixels() / maxEntrySize;
+		if (columnCount == 0)
+			columnCount = 1;
 		int columnWidth = (int) size.convertToPixels() / columnCount;
 		int entriesPerColumn = (int) Math.ceil(1.d * bom.size() / columnCount);
 		if (entriesPerColumn == 0) {
@@ -82,13 +91,20 @@ public class BOM extends AbstractComponent<Void> {
 			return;
 		}
 		for (int i = 0; i < bom.size(); i++) {
+			String valueStr;
+			BomEntry entry = bom.get(i);
+			if (entry.getValue() == null || entry.getValue().trim().isEmpty()) {
+				valueStr = "qty " + entry.getQuantity().toString();
+			} else {
+				valueStr = entry.getValue().toString();
+			}
 			int columnIndex = i / entriesPerColumn;
 			int rowIndex = i % entriesPerColumn;
 			int x = point.x + columnIndex * columnWidth;
 			int y = point.y + rowIndex * maxHeight;
-			g2d.drawString(bom.get(i).getName(), x, y);
+			g2d.drawString(entry.getName(), x, y);
 			x += maxNameWidth + SPACING.convertToPixels();
-			g2d.drawString(bom.get(i).getValue().toString(), x, y);
+			g2d.drawString(valueStr, x, y);
 		}
 	}

@@ -12,12 +12,13 @@ import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
 import org.diylc.core.VisibilityPolicy;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;
 import org.diylc.core.measures.Size;
 import org.diylc.core.measures.SizeUnit;

-@ComponentDescriptor(name = "Ground Symbol", author = "Branislav Stojkovic", category = "Misc", instanceNamePrefix = "GND", description = "Ground schematic symbol", stretchable = false, zOrder = IDIYComponent.COMPONENT)
+@ComponentDescriptor(name = "Ground Symbol", author = "Branislav Stojkovic", category = "Misc", instanceNamePrefix = "GND", description = "Ground schematic symbol", stretchable = false, zOrder = IDIYComponent.COMPONENT, bomPolicy = BomPolicy.NEVER_SHOW)
 public class GroundSymbol extends AbstractComponent<Void> {

 	private static final long serialVersionUID = 1L;
@@ -14,12 +14,13 @@ import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
 import org.diylc.core.VisibilityPolicy;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;

 import com.thoughtworks.xstream.annotations.XStreamConverter;

-@ComponentDescriptor(name = "Image", author = "Branislav Stojkovic", category = "Misc", description = "User defined image", instanceNamePrefix = "Img", zOrder = IDIYComponent.TEXT, stretchable = false)
+@ComponentDescriptor(name = "Image", author = "Branislav Stojkovic", category = "Misc", description = "User defined image", instanceNamePrefix = "Img", zOrder = IDIYComponent.TEXT, stretchable = false, bomPolicy = BomPolicy.NEVER_SHOW)
 public class Image extends AbstractTransparentComponent<Void> {

 	private static final long serialVersionUID = 1L;
@@ -13,10 +13,11 @@ import org.diylc.core.IDIYComponent;
 import org.diylc.core.IDrawingObserver;
 import org.diylc.core.Project;
 import org.diylc.core.VisibilityPolicy;
+import org.diylc.core.annotations.BomPolicy;
 import org.diylc.core.annotations.ComponentDescriptor;
 import org.diylc.core.annotations.EditableProperty;

-@ComponentDescriptor(name = "Label", author = "Branislav Stojkovic", category = "Misc", description = "User defined label", instanceNamePrefix = "L", zOrder = IDIYComponent.TEXT, stretchable = false)
+@ComponentDescriptor(name = "Label", author = "Branislav Stojkovic", category = "Misc", description = "User defined label", instanceNamePrefix = "L", zOrder = IDIYComponent.TEXT, stretchable = false, bomPolicy = BomPolicy.NEVER_SHOW)
 public class Label extends AbstractComponent<Void> {

 	public static String DEFAULT_TEXT = "Double click to edit text";