psdi.app.bim.parser.cobie

Class ItemBase

java.lang.Object

psdi.app.bim.parser.cobie.ItemBase

All Implemented Interfaces:

Item

Direct Known Subclasses:

ItemASSEMBLY, ItemATTRIBUTE, ItemAttributeType, ItemCompany, ItemCOMPONENT, ItemCONTACT, ItemDOCUMENT, ItemGUIDTest, ItemISSUE, ItemJOB, ItemRESOURCE, ItemSpaces, ItemSPARE, ItemSystemBase, ItemTYPE, ItemValueList

public abstract class ItemBase
extends java.lang.Object
implements Item

Constructor Summary

Constructors

Constructor and Description
ItemBase()

Method Summary

Modifier and Type	Method and Description
void	addAttribute(ItemATTRIBUTE attrib)
java.util.Enumeration<ItemATTRIBUTE>	attributes()
static java.lang.String	base64toGUID(java.lang.String base64)
boolean	categoryFromAttribute(java.lang.String omniClassAttribute)
java.util.Enumeration<ItemDOCUMENT>	documents()
void	export(Exporter exporter) Exported representation of Item
ItemATTRIBUTE	getAttribute(java.lang.String name)
int	getAttributeCount()
java.lang.String	getCategory()
java.lang.String	getCreatedBy()
java.lang.String	getCreatedOn()
java.lang.String	getDescription()
ItemDOCUMENT	getDocument(java.lang.String name)
java.lang.String	getExternalIdentifier()
java.lang.String	getExternalObject()
java.lang.String	getExternalSystem()
java.lang.String	getExtIdentifier()
java.lang.String	getExtObject()
java.lang.String	getExtSystem()
ItemFACILITY	getFacilityReference()
java.lang.String	getKey()
java.lang.String	getName()
ItemBase	getParentRef()
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
static boolean	isStringGUID(java.lang.String value)
static boolean	isStringReviUID(java.lang.String value)
void	removeAttribute(java.lang.String name)
void	removeDocument(java.lang.String name)
ItemFACILITY	resolveFacilityRef(Parser project)
void	resolveRerefences(Parser project, long flags) Attempts to establish all the links specified in the various COBie sheet
static java.lang.String	reviUIDroExportGUID(java.lang.String uniqueId)
void	setCategory(java.lang.String category)
void	setCreatedBy(java.lang.String createdBy)
void	setCreatedOn(java.lang.String createdOn)
void	setCreatingContact(ItemCONTACT contact)
void	setDescription(java.lang.String description)
void	setExtIdentifier(java.lang.String extIdentifier)
void	setExtObject(java.lang.String extObject)
void	setExtSystem(java.lang.String extSystem)
void	setFacilityReference(ItemFACILITY facilityRef)
void	setGuidConversionFlag(boolean convert) Determines if the parser attempts to convert base 64 ids to GUIDs
void	setMatch(boolean match)
void	setName(java.lang.String name)
void	setSourceFile(java.lang.String sourceFile)
void	setUniqueId(java.lang.String uniqueId)
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.
java.lang.String	toString()
void	update(Item item) Merge two instances of an object
boolean	valueHasContent(java.lang.String value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.app.bim.parser.cobie.Item

getPageId

Constructor Detail

ItemBase

public ItemBase()

Method Detail

isDuplicat

public boolean isDuplicat(Parser parser,
                          Item item)

Description copied from interface: Item

Called if an item with an identical name is found.

Specified by:

isDuplicat in interface Item

Returns:

false to prevent the item from being added, true to allow item to be added

update

public void update(Item item)

Description copied from interface: 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

Specified by:

update in interface Item

Parameters:

item - The source object

categoryFromAttribute

public boolean categoryFromAttribute(java.lang.String omniClassAttribute)

addAttribute

public void addAttribute(ItemATTRIBUTE attrib)

getAttribute

public ItemATTRIBUTE getAttribute(java.lang.String name)

removeAttribute

public void removeAttribute(java.lang.String name)

attributes

public java.util.Enumeration<ItemATTRIBUTE> attributes()

getAttributeCount

public int getAttributeCount()

getCategory

public java.lang.String getCategory()

setCategory

public void setCategory(java.lang.String category)

getCreatedBy

public java.lang.String getCreatedBy()

setCreatedBy

public void setCreatedBy(java.lang.String createdBy)

getCreatedOn

public java.lang.String getCreatedOn()

setCreatedOn

public void setCreatedOn(java.lang.String createdOn)

setCreatingContact

public void setCreatingContact(ItemCONTACT contact)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Item

setDescription

public void setDescription(java.lang.String description)

getDocument

public ItemDOCUMENT getDocument(java.lang.String name)

removeDocument

public void removeDocument(java.lang.String name)

documents

public java.util.Enumeration<ItemDOCUMENT> documents()

getExtIdentifier

public java.lang.String getExtIdentifier()

getExternalIdentifier

public java.lang.String getExternalIdentifier()

getFacilityReference

public ItemFACILITY getFacilityReference()

setExtIdentifier

public void setExtIdentifier(java.lang.String extIdentifier)

getExtSystem

public java.lang.String getExtSystem()

getExternalSystem

public java.lang.String getExternalSystem()

setExtSystem

public void setExtSystem(java.lang.String extSystem)

setFacilityReference

public void setFacilityReference(ItemFACILITY facilityRef)

getExtObject

public java.lang.String getExtObject()

getExternalObject

public java.lang.String getExternalObject()

setExtObject

public void setExtObject(java.lang.String extObject)

setGuidConversionFlag

public void setGuidConversionFlag(boolean convert)

Description copied from interface: Item

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

Specified by:

setGuidConversionFlag in interface Item

setUniqueIdConversionFlag

public void setUniqueIdConversionFlag(boolean convert)

Description copied from interface: Item

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.

Specified by:

setUniqueIdConversionFlag in interface Item

getKey

public java.lang.String getKey()

Specified by:

getKey in interface Item

isMatch

public boolean isMatch()

Description copied from interface: Item

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

Specified by:

isMatch in interface Item

setMatch

public void setMatch(boolean match)

Specified by:

setMatch in interface Item

getName

public java.lang.String getName()

Specified by:

getName in interface Item

setName

public void setName(java.lang.String name)

getParentRef

public ItemBase getParentRef()

getSourceFile

public java.lang.String getSourceFile()

Description copied from interface: Item

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

Specified by:

getSourceFile in interface Item

Returns:

getUniqueId

public java.lang.String getUniqueId()

Specified by:

getUniqueId in interface Item

setSourceFile

public void setSourceFile(java.lang.String sourceFile)

Specified by:

setSourceFile in interface Item

setUniqueId

public void setUniqueId(java.lang.String uniqueId)

Specified by:

setUniqueId in interface Item

resolveRerefences

public void resolveRerefences(Parser project,
                              long flags)

Description copied from interface: Item

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

Specified by:

resolveRerefences in interface Item

resolveFacilityRef

public ItemFACILITY resolveFacilityRef(Parser project)

skip

public boolean skip(Parser parser,
                    long flags)

Description copied from interface: Item

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

Specified by:

skip in interface Item

Returns:

true causes the item to be discarded

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

valueHasContent

public boolean valueHasContent(java.lang.String value)

export

public void export(Exporter exporter)

Description copied from interface: Item

Exported representation of Item

Specified by:

export in interface Item

Parameters:

exporter - tool used to export item

isStringGUID

public static boolean isStringGUID(java.lang.String value)

isStringReviUID

public static boolean isStringReviUID(java.lang.String value)

base64toGUID

public static java.lang.String base64toGUID(java.lang.String base64)

reviUIDroExportGUID

public static java.lang.String reviUIDroExportGUID(java.lang.String uniqueId)