psdi.app.bim.parser.cobie

Interface Parser

    • Field Detail

      • FLAG_CONVERT_GUID

        static final long FLAG_CONVERT_GUID
        Determines if the parser attempts to convert the value found in ExtIdentifier from a base 64 number to a GUID format

        http://thebuildingcoder.typepad.com/blog/2009/02/uniqueid-dwf-and-ifc-guid.html

        See Also:
        Constant Field Values

      • FLAG_PROMOTE_SPACES

        static final long FLAG_PROMOTE_SPACES
        The COBie spec assumes that ever space will reference a level. This is not always the case with really data and may not be desirable for some service spaces that cross levels. If this flag is set, a space that is not associated with a level is associated with the facility. If it is not set, the space is skipped on import
        See Also:
        Constant Field Values

      • FLAG_PROMOTE_COMPONENTS

        static final long FLAG_PROMOTE_COMPONENTS
        The COBie spec associates components with spaces, but the modeling tools only require a model item to be associated with a level. If this flag is set If the space reference is invalid, the parser attempts to find a floor with the space name (This is an extension to the spec). If that fails, it associates the component with the facility. This insures that all components can be imported
        See Also:
        Constant Field Values

      • FLAG_INFER_LEVELS

        static final long FLAG_INFER_LEVELS
        IF this flag is set, the parser looks for the level attribute and uses its value to set the floor reference in components if it is unset. IF the space reference is not valid, then the loader uses the floor reference to associate the component with a floor instead of a space.
        See Also:
        Constant Field Values

      • FLAG_INFER_SYSTEMS

        static final long FLAG_INFER_SYSTEMS
        The System Name attribute may contain system definition that are not reflected in the COBie data, If this flag is set the parse processes the SystemName attribute and tries to build systems
        See Also:
        Constant Field Values

      • FLAG_SKIP_ON_NULL

        static final long FLAG_SKIP_ON_NULL
        Objects that have a null value are skipped. Each object can implement its own logic to determine if it is null
        See Also:
        Constant Field Values

      • FLAG_SKIP_ON_NO_VALUE

        static final long FLAG_SKIP_ON_NO_VALUE
        Objects that don't have a meaningful value are skipped on load. Each object type can implement it's own logic to determine when an instance should be skipped
        See Also:
        Constant Field Values

      • FLAG_CONVERT_EXTENSION_COLS

        static final long FLAG_CONVERT_EXTENSION_COLS
        Convert unrecognized columns which are usually COBie extension columns to attributes
        See Also:
        Constant Field Values

      • FLAG_CONVERT_UNIQUE_IDs

        static final long FLAG_CONVERT_UNIQUE_IDs
        Identify and convert Revit UniqueIds to Revit export GUIDs
        See Also:
        Constant Field Values

      • FLAG_ALL_CONTACTS_ARE_COMPANIES

        static final long FLAG_ALL_CONTACTS_ARE_COMPANIES
        Causes the parser to generate Companies for all contacts regardless of how they are referenced
        See Also:
        Constant Field Values

      • ERR_EXPORT_FILE_NAME

        static final java.lang.String ERR_EXPORT_FILE_NAME
        See Also:
        Constant Field Values

      • ERR_INVALID_ACCESSOR

        static final java.lang.String ERR_INVALID_ACCESSOR
        See Also:
        Constant Field Values

      • ERR_INVALID_OMNICLASS_STUCT

        static final java.lang.String ERR_INVALID_OMNICLASS_STUCT
        See Also:
        Constant Field Values

      • ERR_INVALID_XLS_FILE_ERROR

        static final java.lang.String ERR_INVALID_XLS_FILE_ERROR
        See Also:
        Constant Field Values

      • ERR_SHEET_CLASS_NOT_FOUND

        static final java.lang.String ERR_SHEET_CLASS_NOT_FOUND
        See Also:
        Constant Field Values

      • ERR_SHEET_INVALID_CLASS

        static final java.lang.String ERR_SHEET_INVALID_CLASS
        See Also:
        Constant Field Values

      • ERR_UNSUPPORTED_FILE_TYPE

        static final java.lang.String ERR_UNSUPPORTED_FILE_TYPE
        See Also:
        Constant Field Values

      • WRN_OPEN_STYLE_TEMPLATE

        static final java.lang.String WRN_OPEN_STYLE_TEMPLATE
        See Also:
        Constant Field Values

      • WRN_MISSING_COL_NAME

        static final java.lang.String WRN_MISSING_COL_NAME
        See Also:
        Constant Field Values

      • WRN_MISSING_PROPERTY

        static final java.lang.String WRN_MISSING_PROPERTY
        See Also:
        Constant Field Values

      • WRN_INVALID_CELL_VALUE

        static final java.lang.String WRN_INVALID_CELL_VALUE
        See Also:
        Constant Field Values

      • MSG_FILE_NOT_FOUND_ERROR

        static final java.lang.String MSG_FILE_NOT_FOUND_ERROR
        See Also:
        Constant Field Values

      • VALIDATE_ATTRIB_VALUE_IS_NAME

        static final java.lang.String VALIDATE_ATTRIB_VALUE_IS_NAME
        See Also:
        Constant Field Values

      • VALIDATE_DUPLICATE_ITEM

        static final java.lang.String VALIDATE_DUPLICATE_ITEM
        See Also:
        Constant Field Values

      • VALIDATE_MISSING_REF

        static final java.lang.String VALIDATE_MISSING_REF
        See Also:
        Constant Field Values

      • VALIDATE_MISSING_ROW_REF

        static final java.lang.String VALIDATE_MISSING_ROW_REF
        See Also:
        Constant Field Values

      • VALIDATE_MISSING_SHEET_REF

        static final java.lang.String VALIDATE_MISSING_SHEET_REF
        See Also:
        Constant Field Values

      • VALIDATE_UNRESOLVED_REF

        static final java.lang.String VALIDATE_UNRESOLVED_REF
        See Also:
        Constant Field Values

      • VALIDATE_VALUELIST_MISMATCH

        static final java.lang.String VALIDATE_VALUELIST_MISMATCH
        See Also:
        Constant Field Values

      • VALIDATE_TASK_PREREQ_MISSING

        static final java.lang.String VALIDATE_TASK_PREREQ_MISSING
        See Also:
        Constant Field Values

      • VALIDATE_TASK_NUMBER

        static final java.lang.String VALIDATE_TASK_NUMBER
        See Also:
        Constant Field Values

      • VALIDATE_MISSING_CHILD_REF

        static final java.lang.String VALIDATE_MISSING_CHILD_REF
        See Also:
        Constant Field Values

      • VALIDATE_MISSING_PARENT_REF

        static final java.lang.String VALIDATE_MISSING_PARENT_REF
        See Also:
        Constant Field Values

    • Method Detail

      • addSkippedSpace

        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
        Parameters:
        spaceName - Name of the skipped pace;

      • export

        void export(java.lang.String fileName,
            java.lang.String[] pageList,
            java.io.InputStream template,
            ExportProgressTracker tracker,
            Exporter.ExportFormat fileFormat)
        Parsers should implement this method to support export functionality
        Parameters:
        fileName - Name of export file
        pageList - List of pages to export
        template - JSOM configuration object describing excel formating
        tracker - Progress tracker
        fileFormat - Export file format xls or xlsx

      • filters

        java.util.Iterator filters()
        List of filters to restrict value on input.
        Returns:

      • getCompanyFromContact

        ItemCONTACT getCompanyFromContact(java.lang.String companyName)

      • addConvertedField

        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
        Parameters:
        tableName -
        fieldName -
        attributeName - COBie attribute name to which the field is converted

      • getConvertedField

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

      • getVendorAttribute

        java.lang.String getVendorAttribute()
        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
        Returns:

      • getItem

        Item getItem(java.lang.String pageName,
             java.lang.String key)
        Retrieves an item from the parse tree
        Parameters:
        pageName -
        key -
        Returns:

      • getItemCount

        int getItemCount()
        This is set by resolveReferences, and is used to show a % complete
        Returns:
        The total number of items loaded by the parser

      • getLocale

        java.util.Locale getLocale()

      • getPage

        Page getPage(java.lang.String pageName)

      • isSpaceSkipped

        boolean isSpaceSkipped(java.lang.String spaceName)
        Test if spaceName is in the skipped spaces list
        Parameters:
        spaceName -
        Returns:

      • convertCase

        java.lang.String convertCase(java.lang.String s)
        Provides a centralized place to control if the parser is case sensitive. Only partially implemented.
        Parameters:
        s -
        Returns:
Skip navigation links