psdi.app.bim.parser.cobie

Class BIMProjectParser

java.lang.Object

psdi.app.bim.parser.cobie.BIMProjectParser

All Implemented Interfaces:

Parser

public class BIMProjectParser
extends java.lang.Object
implements Parser

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	_pageNames List of supported COBie Sheet names in the order to be processed

Fields inherited from interface psdi.app.bim.parser.cobie.Parser

ERR_BAD_URL, ERR_EXCEL_NO_URL, ERR_EXPORT_ERROR, ERR_EXPORT_FILE_NAME, ERR_FILE_OPEN, ERR_FILE_READ_ERROR, ERR_INVALID_ACCESSOR, ERR_INVALID_OMNICLASS_STUCT, ERR_INVALID_XLS_FILE_ERROR, ERR_SHEET_CLASS_NOT_FOUND, ERR_SHEET_INVALID_CLASS, ERR_UNSUPPORTED_FILE_TYPE, FLAG_ALL_CONTACTS_ARE_COMPANIES, FLAG_CONVERT_EXTENSION_COLS, FLAG_CONVERT_GUID, FLAG_CONVERT_UNIQUE_IDs, FLAG_INFER_LEVELS, FLAG_INFER_SYSTEMS, FLAG_PROMOTE_COMPONENTS, FLAG_PROMOTE_SPACES, FLAG_SKIP_ON_NO_VALUE, FLAG_SKIP_ON_NULL, ITEM_CLASS_PREFIX, MSG_FILE_CREATED, MSG_FILE_NOT_FOUND_ERROR, MSG_FILE_PARSED, MSG_LOADING_STYLES, MSG_VERSION, SHEET_ASSEMBLY, SHEET_ATTRIB_TYPE, SHEET_ATTRIBUTE, SHEET_COMPANY, SHEET_COMPONENT, SHEET_CONTACT, SHEET_DOCUMENT, SHEET_EXCEL, SHEET_FACILITY, SHEET_FLOOR, SHEET_ISSUE, SHEET_JOB, SHEET_RESOURCE, SHEET_SPACE, SHEET_SPARE, SHEET_SYSTEM, SHEET_TYPE, SHEET_VALUE_LIST, SHEET_ZONE, VALIDATE_ATTRIB_VALUE_IS_NAME, VALIDATE_DUPLICATE_ITEM, VALIDATE_MISSING_CHILD_REF, VALIDATE_MISSING_PARENT_REF, VALIDATE_MISSING_REF, VALIDATE_MISSING_ROW_REF, VALIDATE_MISSING_SHEET_REF, VALIDATE_SPACE_LIST, VALIDATE_TASK_NUMBER, VALIDATE_TASK_PREREQ_MISSING, VALIDATE_UNRESOLVED_REF, VALIDATE_VALUELIST_MISMATCH, WRN_INVALID_CELL_VALUE, WRN_MISSING_COL_NAME, WRN_MISSING_PROPERTY, WRN_OPEN_STYLE_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
BIMProjectParser(IdFactory idFactory, MessageLogger logger, java.util.Locale locale, long flags)
BIMProjectParser(long flags)

Method Summary

Modifier and Type	Method and Description
void	addConvertedField(java.lang.String tableName, java.lang.String fieldName, java.lang.String attributeName) Fields in this list are converted to COBie attributes instead of treated as standard parts of the COBie table.
void	addFile(InputFile cobieFile) Specify the file name for a single sheet from a COBie spread sheet to loading
void	addFilter(Filter filter)
void	addPage(Page page)
void	addSkippedSpace(java.lang.String spaceName) The parser tracks all spaces that are skipped so that things that reference a skipped space can also be skipped
void	areaFromAttribute(java.lang.String areaAttribute)
void	associateCategoriesWithAttributeTypes(java.lang.String[] pageList)
void	caculateItemCount()
void	categoryFromAttribute(java.lang.String omniClassAttribute) Populate the COBie category field from the specified attribute
void	clenup()
java.lang.String	convertCase(java.lang.String s) Provides a centralized place to control if the parser is case sensitive.
void	deleteFiles(java.lang.String workingDirRoot)
void	execute()
void	export(java.lang.String fileName, java.lang.String[] pageList, java.io.InputStream templateStream, ExportProgressTracker tracker, Exporter.ExportFormat fileFormat) Parsers should implement this method to support export functionality
java.util.Iterator<Filter>	filters() List of filters to restrict value on input.
ItemAttributeType	getAttributeType(java.lang.String typeName)
AttributeTypeMap	getCategoryMap()
ItemCONTACT	getCompanyFromContact(java.lang.String companyName)
java.lang.String	getConvertedField(java.lang.String tableName, java.lang.String fieldName)
Item	getItem(java.lang.String pageName, java.lang.String key) Retrieves an item from the parse tree
int	getItemCount() This is set by resolveReferences, and is used to show a % complete
java.util.Locale	getLocale()
MessageLogger	getLogger()
Page	getPage(java.lang.String pageName)
ItemValueList	getValueList(java.util.HashSet<java.lang.String> valueSet)
java.lang.String	getVendorAttribute() An attribute name can be specified for components that has company reference for the supplier/vendor of the component.
boolean	isSpaceSkipped(java.lang.String spaceName) Test if spaceName is in the skipped spaces list
void	levelsFromAttribute(java.lang.String levelAttrib)
static void	main(java.lang.String[] args)
static java.lang.String	messageFromException(java.lang.Throwable t)
void	perimeterFromAttribute(java.lang.String perimeterAttribute)
void	printAll()
void	printPage(Page page)
void	resolveReferences() Walk the parse tree and call resolve reference on every item found Must be called after all data is loaded.
void	setLogger(MessageLogger logger)
void	setVendorAttribute(java.lang.String vendorAttribute)
void	spacesFromAttribute(java.lang.String spaceAttrib)
void	systemsFromAttribute(java.lang.String systemNameAttrib)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_pageNames

public static final java.lang.String[] _pageNames

List of supported COBie Sheet names in the order to be processed

Constructor Detail

BIMProjectParser

public BIMProjectParser(long flags)

BIMProjectParser

public BIMProjectParser(IdFactory idFactory,
                        MessageLogger logger,
                        java.util.Locale locale,
                        long flags)

Method Detail

addConvertedField

public void addConvertedField(java.lang.String tableName,
                              java.lang.String fieldName,
                              java.lang.String attributeName)

Fields in this list are converted to COBie attributes instead of treated as standard parts of the COBie table. Use of this mechanism should Normally be restricted to the green optional columns

Specified by:

addConvertedField in interface Parser

Parameters:

tableName -

fieldName -

attributeName - COBie attribute name to which the field is converted

getConvertedField

public java.lang.String getConvertedField(java.lang.String tableName,
                                          java.lang.String fieldName)

Specified by:

getConvertedField in interface Parser

addFile

public void addFile(InputFile cobieFile)
             throws ParseException

Specify the file name for a single sheet from a COBie spread sheet to loading

Parameters:

fileName -

sheetName -

Throws:

ParseException

addSkippedSpace

public void addSkippedSpace(java.lang.String spaceName)

Description copied from interface: Parser

The parser tracks all spaces that are skipped so that things that reference a skipped space can also be skipped

Specified by:

addSkippedSpace in interface Parser

Parameters:

spaceName - Name of the skipped pace;

isSpaceSkipped

public boolean isSpaceSkipped(java.lang.String spaceName)

Description copied from interface: Parser

Test if spaceName is in the skipped spaces list

Specified by:

isSpaceSkipped in interface Parser

Returns:

addFilter

public void addFilter(Filter filter)

filters

public java.util.Iterator<Filter> filters()

Description copied from interface: Parser

List of filters to restrict value on input.

Specified by:

filters in interface Parser

Returns:

execute

public void execute()

deleteFiles

public void deleteFiles(java.lang.String workingDirRoot)

addPage

public void addPage(Page page)

clenup

public void clenup()

resolveReferences

public void resolveReferences()

Walk the parse tree and call resolve reference on every item found Must be called after all data is loaded.

categoryFromAttribute

public void categoryFromAttribute(java.lang.String omniClassAttribute)

Populate the COBie category field from the specified attribute

Parameters:

omniClassAttribute -

spacesFromAttribute

public void spacesFromAttribute(java.lang.String spaceAttrib)

levelsFromAttribute

public void levelsFromAttribute(java.lang.String levelAttrib)

areaFromAttribute

public void areaFromAttribute(java.lang.String areaAttribute)

perimeterFromAttribute

public void perimeterFromAttribute(java.lang.String perimeterAttribute)

systemsFromAttribute

public void systemsFromAttribute(java.lang.String systemNameAttrib)

associateCategoriesWithAttributeTypes

public void associateCategoriesWithAttributeTypes(java.lang.String[] pageList)

getValueList

public ItemValueList getValueList(java.util.HashSet<java.lang.String> valueSet)

caculateItemCount

public void caculateItemCount()

getPage

public Page getPage(java.lang.String pageName)

Specified by:

getPage in interface Parser

getItem

public Item getItem(java.lang.String pageName,
                    java.lang.String key)

Description copied from interface: Parser

Retrieves an item from the parse tree

Specified by:

getItem in interface Parser

Returns:

getAttributeType

public ItemAttributeType getAttributeType(java.lang.String typeName)

getCompanyFromContact

public ItemCONTACT getCompanyFromContact(java.lang.String companyName)

Specified by:

getCompanyFromContact in interface Parser

convertCase

public java.lang.String convertCase(java.lang.String s)

Provides a centralized place to control if the parser is case sensitive. Only partially implemented.

Specified by:

convertCase in interface Parser

Parameters:

s -

Returns:

getCategoryMap

public AttributeTypeMap getCategoryMap()

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface Parser

getItemCount

public int getItemCount()

Description copied from interface: Parser

This is set by resolveReferences, and is used to show a % complete

Specified by:

getItemCount in interface Parser

Returns:

The total number of items loaded by the parser

getVendorAttribute

public java.lang.String getVendorAttribute()

Description copied from interface: Parser

An attribute name can be specified for components that has company reference for the supplier/vendor of the component. The reference is to the company name not the contact email

Specified by:

getVendorAttribute in interface Parser

Returns:

printPage

public void printPage(Page page)

printAll

public void printAll()

getLogger

public MessageLogger getLogger()

Specified by:

getLogger in interface Parser

setLogger

public void setLogger(MessageLogger logger)

setVendorAttribute

public void setVendorAttribute(java.lang.String vendorAttribute)

export

public void export(java.lang.String fileName,
                   java.lang.String[] pageList,
                   java.io.InputStream templateStream,
                   ExportProgressTracker tracker,
                   Exporter.ExportFormat fileFormat)

Description copied from interface: Parser

Parsers should implement this method to support export functionality

Specified by:

export in interface Parser

Parameters:

fileName - Name of export file

pageList - List of pages to export

templateStream - JSOM configuration object describing excel formating

tracker - Progress tracker

fileFormat - Export file format xls or xlsx

messageFromException

public static java.lang.String messageFromException(java.lang.Throwable t)

main

public static void main(java.lang.String[] args)