com.rapidtransform.part.model
Class ItemView

java.lang.Object
  extended by com.rapidtransform.core.model.AbstractBaseModel
      extended by com.rapidtransform.core.model.VersionControlled
          extended by com.rapidtransform.part.model.ItemView
All Implemented Interfaces:
Classified, Model, Versioned, Approvable, OrganizationalData, OrganizationElement, ItemInformation, FinalDefinition, PhysicalInstanceDefinition, java.io.Serializable
Direct Known Subclasses:
Assembly, CollectionView

public class ItemView
extends VersionControlled
implements FinalDefinition, ItemInformation, Classified, Approvable, OrganizationElement, OrganizationalData, PhysicalInstanceDefinition

This class represents a view of a specific item. In the STEP standard, this is referred to as the design discipline item definition. The view is relevant for one or more application contexts and contains the product data for a item version.

Author:
Steve
See Also:
Serialized Form

Constructor Summary
ItemView()
          Default constructor
ItemView(java.lang.String name, ItemVersion fromVersion, ApplicationContext initialContext)
          Constructs an ItemView with the given ItemVersion as it's parent.
 
Method Summary
 void addAlias(Alias alias)
          Adds an alias to the set of aliases
 void addApplicationContext(ApplicationContext context)
          Adds an application context to the set of additional contexts.
 void addDocument(Document document)
          Adds a document to the set of documents.
 void addItemInstance(ItemInstance instance)
          Adds another item instances to the set of instances that implement this view.
 boolean equals(java.lang.Object other)
           
 java.util.Collection<ApplicationContext> getAdditionalContexts()
          Additional contexts can be added for this ItemView if it can be used in other states or application domains in addition to the initial context.
 java.util.Collection<Alias> getAliases()
          The aliases specify how this item is identified outside the immediate organization - that is, how a partner/manufacturer identifies the item.
 java.util.Collection<Document> getDocuments()
           
 ApplicationContext getInitialContext()
          The initial context for this item specifies the applicable state and domain where this ItemView can initially be used in the item/product definition process.
 java.util.Collection<ItemFunctionAssociation> getItemFunctions()
          Relates this ItemView with a product function.
 java.util.Collection<ItemInstance> getItemInstances()
          The ItemInstances that implement this ItemView
 ItemVersion getItemVersion()
          An association back to the ItemVersion from which this ItemView is created.
 java.util.Collection<ItemViewRelation> getItemViewRelations()
          Links this ItemView with other ItemViews.
 java.lang.String getName()
           
 java.util.Collection<ItemViewInstanceRelation> getViewInstanceRelations()
          This relation is used for linking an ItemView to other ItemInstances that do not implement this ItemView.
 int hashCode()
           
 void setAdditionalContexts(java.util.Set<ApplicationContext> additionalContexts)
           
 void setAliases(java.util.Set<Alias> aliases)
           
 void setDocuments(java.util.Set<Document> documents)
           
 void setInitialContext(ApplicationContext initialContext)
           
 void setItemFunctions(java.util.Set<ItemFunctionAssociation> itemFunctions)
           
 void setItemInstances(java.util.Set<ItemInstance> itemInstances)
           
 void setItemVersion(ItemVersion itemVersion)
           
 void setItemViewRelations(java.util.Set<ItemViewRelation> itemViewRelations)
           
 void setName(java.lang.String name)
           
 void setViewInstanceRelations(java.util.Set<ItemViewInstanceRelation> viewInstanceRelations)
           
 
Methods inherited from class com.rapidtransform.core.model.VersionControlled
getCreatedBy, getCreatedDate, getIteration, getModifiedBy, getModifiedDate, setCreatedBy, setCreatedDate, setIteration, setModifiedBy, setModifiedDate
 
Methods inherited from class com.rapidtransform.core.model.AbstractBaseModel
generateUuid, getId, getMetaTypeName, getPropertyHolder, getUuid, setId, setMetaTypeName, setPropertyHolder, setUuid
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ItemView

public ItemView()
Default constructor


ItemView

public ItemView(java.lang.String name,
                ItemVersion fromVersion,
                ApplicationContext initialContext)
Constructs an ItemView with the given ItemVersion as it's parent. The parameters specify the required attributes for this class.

Parameters:
name -
fromVersion -
initialContext -
Method Detail

getAdditionalContexts

public java.util.Collection<ApplicationContext> getAdditionalContexts()
Additional contexts can be added for this ItemView if it can be used in other states or application domains in addition to the initial context.

Returns:
Returns the additionalContexts.

setAdditionalContexts

public void setAdditionalContexts(java.util.Set<ApplicationContext> additionalContexts)
Parameters:
additionalContexts - The additionalContexts to set.

addApplicationContext

public void addApplicationContext(ApplicationContext context)
Adds an application context to the set of additional contexts.

Parameters:
context -

getAliases

public java.util.Collection<Alias> getAliases()
The aliases specify how this item is identified outside the immediate organization - that is, how a partner/manufacturer identifies the item.

Returns:
Returns the alias.

setAliases

public void setAliases(java.util.Set<Alias> aliases)
Parameters:
alias - The alias to set.

addAlias

public void addAlias(Alias alias)
Adds an alias to the set of aliases

Parameters:
alias -

getDocuments

public java.util.Collection<Document> getDocuments()
Returns:
Returns the documents.

setDocuments

public void setDocuments(java.util.Set<Document> documents)
Parameters:
documents - The documents to set.

addDocument

public void addDocument(Document document)
Adds a document to the set of documents.

Parameters:
document -

getInitialContext

public ApplicationContext getInitialContext()
The initial context for this item specifies the applicable state and domain where this ItemView can initially be used in the item/product definition process.

Returns:
Returns the initialContext.

setInitialContext

public void setInitialContext(ApplicationContext initialContext)
Parameters:
initialContext - The initialContext to set.

getItemFunctions

public java.util.Collection<ItemFunctionAssociation> getItemFunctions()
Relates this ItemView with a product function.

Returns:
Returns the itemFunctions.

setItemFunctions

public void setItemFunctions(java.util.Set<ItemFunctionAssociation> itemFunctions)
Parameters:
itemFunctions - The itemFunctions to set.

getItemInstances

public java.util.Collection<ItemInstance> getItemInstances()
The ItemInstances that implement this ItemView

Returns:
Returns the itemInstances.

setItemInstances

public void setItemInstances(java.util.Set<ItemInstance> itemInstances)
Parameters:
itemInstances - The itemInstances to set.

addItemInstance

public void addItemInstance(ItemInstance instance)
Adds another item instances to the set of instances that implement this view.


getItemViewRelations

public java.util.Collection<ItemViewRelation> getItemViewRelations()
Links this ItemView with other ItemViews. This is used to create MakeFrom and Replaced relationships, as well as a relationship with a Tool or a general relation to another ItemView.

Returns:
Returns the itemViewRelation.

setItemViewRelations

public void setItemViewRelations(java.util.Set<ItemViewRelation> itemViewRelations)
Parameters:
itemViewRelation - The itemViewRelation to set.

getName

public java.lang.String getName()
Returns:
Returns the name.

setName

public void setName(java.lang.String name)
Parameters:
name - The name to set.

getViewInstanceRelations

public java.util.Collection<ItemViewInstanceRelation> getViewInstanceRelations()
This relation is used for linking an ItemView to other ItemInstances that do not implement this ItemView. If this ItemView is an Assembly, then this relation will specify the subassembly children. If this is a Collection, then the relation links the ItemView to other items that are used for the finished product, but are not assembled together.

Returns:
Returns the viewInstanceRelations.

setViewInstanceRelations

public void setViewInstanceRelations(java.util.Set<ItemViewInstanceRelation> viewInstanceRelations)
Parameters:
viewInstanceRelations - The viewInstanceRelation to set.

getItemVersion

public ItemVersion getItemVersion()
An association back to the ItemVersion from which this ItemView is created.

Returns:
Returns the itemVersion.

setItemVersion

public void setItemVersion(ItemVersion itemVersion)
Parameters:
itemVersion - The itemVersion to set.

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class AbstractBaseModel

hashCode

public int hashCode()
Overrides:
hashCode in class AbstractBaseModel