psdi.app.bim.parser.cobie

Interface Item

All Known Implementing Classes:

ItemASSEMBLY, ItemATTRIBUTE, ItemAttributeType, ItemBase, ItemCompany, ItemCOMPONENT, ItemCONTACT, ItemDOCUMENT, ItemFACILITY, ItemFLOOR, ItemGUIDTest, ItemISSUE, ItemJOB, ItemRESOURCE, ItemSPACE, ItemSpaces, ItemSPARE, ItemSYSTEM, ItemSystemBase, ItemTYPE, ItemValueList, ItemZONE

public interface Item

Method Summary

Modifier and Type	Method and Description
void	export(Exporter exporter) Exported representation of Item
java.lang.String	getDescription()
java.lang.String	getKey()
java.lang.String	getName()
java.lang.String	getPageId()
java.lang.String	getSourceFile() It is desirable to combine multiple COBie work books into a single import such as a s work book from the architectural model and one from the mechanical model.
java.lang.String	getUniqueId()
boolean	isDuplicat(Parser parser, Item item) Called if an item with an identical name is found.
boolean	isMatch() Used by the loader to indicate a match to an existing record in the target system
void	resolveRerefences(Parser project, long flags) Attempts to establish all the links specified in the various COBie sheet
void	setGuidConversionFlag(boolean convert) Determines if the parser attempts to convert base 64 ids to GUIDs
void	setMatch(boolean match)
void	setSourceFile(java.lang.String sourceFile)
void	setUniqueId(java.lang.String uniqueIdentifier)
void	setUniqueIdConversionFlag(boolean convert) Revid uses a UniqueID for its internal object identifications.
boolean	skip(Parser parser, long flags) Called after the item is loaded but before it is added to a page.
void	update(Item item) Merge two instances of an object

Method Detail

isDuplicat

boolean isDuplicat(Parser parser,
                   Item item)

Called if an item with an identical name is found.

Parameters:

item -

Returns:

true to add to the parse tree false to ignore

getDescription

java.lang.String getDescription()

getKey

java.lang.String getKey()

getName

java.lang.String getName()

getPageId

java.lang.String getPageId()

Returns:

The COBie tab name for the object

getSourceFile

java.lang.String getSourceFile()

It is desirable to combine multiple COBie work books into a single import such as a s work book from the architectural model and one from the mechanical model. Items with the same name but different source files are assumed to be the same item and are merged

Returns:

setSourceFile

void setSourceFile(java.lang.String sourceFile)

setGuidConversionFlag

void setGuidConversionFlag(boolean convert)

Determines if the parser attempts to convert base 64 ids to GUIDs

Parameters:

convert -

setUniqueIdConversionFlag

void setUniqueIdConversionFlag(boolean convert)

Revid uses a UniqueID for its internal object identifications. This is a GUID plus the 8 digit Hex Revit element ID. Revit uses a export GUID for most identity in most external representations. However the COBie toolkit exports the UniqueId. The UniqueId can be converted to the export GUID by Xoring the element id portion with the last 8 characters of the GUID.

If this flag is set each external identifier is tested to determine if it is the UniqueID format and if it is, it is converted to the and export GUID.

Parameters:

convert -

skip

boolean skip(Parser parser,
             long flags)

Called after the item is loaded but before it is added to a page.

Returns:

true causes the item to be discarded

getUniqueId

java.lang.String getUniqueId()

setUniqueId

void setUniqueId(java.lang.String uniqueIdentifier)

resolveRerefences

void resolveRerefences(Parser project,
                       long flags)

Attempts to establish all the links specified in the various COBie sheet

Parameters:

project -

flags -

update

void update(Item item)

Merge two instances of an object

Fields that are blank in the target object are updates with values for fields in the source object

Parameters:

item - The source object

isMatch

boolean isMatch()

Used by the loader to indicate a match to an existing record in the target system

setMatch

void setMatch(boolean match)

export

void export(Exporter exporter)

Exported representation of Item

Parameters:

exporter - tool used to export item