Finding Columns¶
Finding Columns¶
1ot = impact.gui.output_toolbox
2db = impact.active_database
3
4
5def describe_column(name, column):
6 if column is None or (hasattr(column, "isNone") and column.isNone()):
7 ot.add("Unable to locate column '" + str(name) + "'")
8
9 else:
10 ot.add("Found Column: " + str(name))
11 ot.add(" Name: " + str(column.name))
12 ot.add(" Type: " + str(column.type))
13
14 if column.known_column != ipDocumentKnownColumn.dkcCustom:
15 ot.add(" KnownColumn: " + str(column.known_column))
16
17
18ot.clear()
19
20doc_settings = db.settings.document_settings
21
22ot.add("=== Find all document columns ===")
23
24def_doc_type = doc_settings.types.default_document_type
25all_columns = def_doc_type.columns
26
27ot.add("Default Document Type: " + def_doc_type.name + " (" + def_doc_type.key + ")")
28ot.add("All Document Columns: " + str(all_columns.count))
29
30# find known document columns
31describe_column("ipDocumentKnownColumn.dkcName", all_columns.known_item(ipDocumentKnownColumn.dkcName))
32describe_column("ipDocumentKnownColumn.dkcSize", all_columns.known_item(ipDocumentKnownColumn.dkcSize))
33describe_column("ipDocumentKnownColumn.dkcGroup", all_columns.known_item(ipDocumentKnownColumn.dkcGroup))
34
35# find custom columns (ensures KnownColumn == ipDocumentKnownColumn.dkcCustom)
36describe_column("DC_WIDTH", all_columns.custom_item("DC_WIDTH"))
37describe_column("DC_HEIGHT", all_columns.custom_item("DC_HEIGHT"))
38
39# find any column by name (not recommended for KnownColumn != ipDocumentKnownColumn.dkcCustom)
40describe_column("DC_NAME", all_columns.item("DC_NAME"))
41
42ot.add("=== Find columns for a specific IDocumentType ===")
43
44cad_doc_type = doc_settings.types.item("impact:cad")
45cad_columns = cad_doc_type.columns
46
47ot.add("CAD Document Type: " + cad_doc_type.name + " (" + cad_doc_type.key + ")")
48ot.add("CAD Document Columns: " + str(cad_columns.count))
49
50# find known columns for CAD document type
51describe_column("ipDocumentKnownColumn.dkcName", cad_columns.known_item(ipDocumentKnownColumn.dkcName))
52describe_column("ipDocumentKnownColumn.dkcSize", cad_columns.known_item(ipDocumentKnownColumn.dkcSize))
53
54# find custom columns for CAD document type (should fail in typical configuration)
55describe_column("DC_WIDTH", cad_columns.custom_item("DC_WIDTH"))