Module com.foursoft.harness.vec.v113
Package com.foursoft.harness.vec.v113

Class VecDocumentVersion

java.lang.Object
com.foursoft.harness.vec.v113.VecExtendableElement
com.foursoft.harness.vec.v113.VecItemVersion
com.foursoft.harness.vec.v113.VecDocumentVersion
All Implemented Interfaces:
Identifiable, ModifiableIdentifiable, HasCustomProperties<VecCustomProperty>, HasDescription<VecAbstractLocalizedString>, HasSpecifications<VecSpecification>, Visitable, Serializable
public class VecDocumentVersion extends VecItemVersion implements Serializable, HasSpecifications<VecSpecification>, Visitable

The DocumentVersion is one of the two anchors for PDM information in the VEC. All technical information about a PartVersion is contained in one or more documents. The documents are containing the actual content of the VEC since all Specifications are an element of a document.

Java class for DocumentVersion complex type.

The following schema fragment specifies the expected content contained within this class. 


 <complexType name="DocumentVersion">
   <complexContent>
     <extension base="{http://www.prostep.org/ecad-if/2011/vec}ItemVersion">
       <sequence>
         <element name="DocumentNumber" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="DocumentType" type="{http://www.prostep.org/ecad-if/2011/vec}DocumentType" minOccurs="0"/>
         <element name="DocumentVersion" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="CreatingSystem" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="DataFormat" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="FileName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Location" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="NumberOfSheets" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ReferencedPart" type="{http://www.w3.org/2001/XMLSchema}IDREFS" minOccurs="0"/>
         <element name="RelatedDocument" type="{http://www.w3.org/2001/XMLSchema}IDREFS" minOccurs="0"/>
         <element name="ItemEquivalence" type="{http://www.prostep.org/ecad-if/2011/vec}ItemEquivalence" maxOccurs="unbounded" minOccurs="0"/>
         <element name="SheetOrChapter" type="{http://www.prostep.org/ecad-if/2011/vec}SheetOrChapter" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Specification" type="{http://www.prostep.org/ecad-if/2011/vec}Specification" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
See Also:

  • Field Details

    • documentNumber

      protected String documentNumber

      The documentNumber is the major identifier of a DocumentVersion. The format is user defined and respectively company specific. Over all VEC-documents a DocumentVersion-instance can be trusted to be identical if the combination of documentNumber, documentVersion and companyName is identical.

    • documentType

      protected String documentType

      The type of the document, that is defined in anOpenEnumerationand gives a hint about the content of the document. Values for typical types of documents in the process are predefined (e.g. a part master document for the specification of aPartVersion).

      At later point, further constraint migth be attached todocumentTypedefining a minimum content for certain types of documents.

    • documentVersion

      protected String documentVersion

      The documentVersion specifies the version index of a document (see also documentNumber).

    • creatingSystem

      protected String creatingSystem

      The creatingSystem specifies the computer application or the machine which is used to create the document.

    • dataFormat

      protected String dataFormat

      The dataFormat specifies the convention that was used to structure the information in the document. This is useful if the DocumentVersion is actually a pointer to an external document, which is not contained in the VEC or if the content of this DocumentVersion was automatically generated by the extraction of the information out of the original document.

    • fileName

      protected String fileName

      If this DocumentVersion is a link to an external document (e.g. a ComponentSymbol), then the fileName attribute points to the file containing the original document. To use this attribute is only valid, if the original document is distributed along with the VEC-file e.g. in a ZIP-archive. It must not point to any file location which is not part of the bundle provided together with the VEC-file (e.g. a File on a central server file share).

    • location

      protected String location

      The location specifies where a document can be found in a digital or physical data storage system.

    • numberOfSheets

      protected String numberOfSheets

      The number of sheets contained in the document.

    • referencedPart

      protected List<VecPartVersion> referencedPart

    • relatedDocument

      protected List<VecDocumentVersion> relatedDocument

    • itemEquivalences

      protected List<VecItemEquivalence> itemEquivalences

    • sheetOrChapters

      protected List<VecSheetOrChapter> sheetOrChapters

    • specifications

      protected List<VecSpecification> specifications

  • Constructor Details

    • VecDocumentVersion

      public VecDocumentVersion()

  • Method Details

    • getDocumentNumber

      public String getDocumentNumber()
      Gets the value of the documentNumber property.

      The documentNumber is the major identifier of a DocumentVersion. The format is user defined and respectively company specific. Over all VEC-documents a DocumentVersion-instance can be trusted to be identical if the combination of documentNumber, documentVersion and companyName is identical.

      Returns:
      possible object is String

    • setDocumentNumber

      public void setDocumentNumber(String value)
      Sets the value of the documentNumber property.
      Parameters:
      value - allowed object is String
      See Also:

    • getDocumentType

      public String getDocumentType()
      Gets the value of the documentType property.

      The type of the document, that is defined in anOpenEnumerationand gives a hint about the content of the document. Values for typical types of documents in the process are predefined (e.g. a part master document for the specification of aPartVersion).

      At later point, further constraint migth be attached todocumentTypedefining a minimum content for certain types of documents.

      Returns:
      possible object is String

    • setDocumentType

      public void setDocumentType(String value)
      Sets the value of the documentType property.
      Parameters:
      value - allowed object is String
      See Also:

    • getDocumentVersion

      public String getDocumentVersion()
      Gets the value of the documentVersion property.

      The documentVersion specifies the version index of a document (see also documentNumber).

      Returns:
      possible object is String

    • setDocumentVersion

      public void setDocumentVersion(String value)
      Sets the value of the documentVersion property.
      Parameters:
      value - allowed object is String
      See Also:

    • getCreatingSystem

      public String getCreatingSystem()
      Gets the value of the creatingSystem property.

      The creatingSystem specifies the computer application or the machine which is used to create the document.

      Returns:
      possible object is String

    • setCreatingSystem

      public void setCreatingSystem(String value)
      Sets the value of the creatingSystem property.
      Parameters:
      value - allowed object is String
      See Also:

    • getDataFormat

      public String getDataFormat()
      Gets the value of the dataFormat property.

      The dataFormat specifies the convention that was used to structure the information in the document. This is useful if the DocumentVersion is actually a pointer to an external document, which is not contained in the VEC or if the content of this DocumentVersion was automatically generated by the extraction of the information out of the original document.

      Returns:
      possible object is String

    • setDataFormat

      public void setDataFormat(String value)
      Sets the value of the dataFormat property.
      Parameters:
      value - allowed object is String
      See Also:

    • getFileName

      public String getFileName()
      Gets the value of the fileName property.

      If this DocumentVersion is a link to an external document (e.g. a ComponentSymbol), then the fileName attribute points to the file containing the original document. To use this attribute is only valid, if the original document is distributed along with the VEC-file e.g. in a ZIP-archive. It must not point to any file location which is not part of the bundle provided together with the VEC-file (e.g. a File on a central server file share).

      Returns:
      possible object is String

    • setFileName

      public void setFileName(String value)
      Sets the value of the fileName property.
      Parameters:
      value - allowed object is String
      See Also:

    • getLocation

      public String getLocation()
      Gets the value of the location property.

      The location specifies where a document can be found in a digital or physical data storage system.

      Returns:
      possible object is String

    • setLocation

      public void setLocation(String value)
      Sets the value of the location property.
      Parameters:
      value - allowed object is String
      See Also:

    • getNumberOfSheets

      public String getNumberOfSheets()
      Gets the value of the numberOfSheets property.

      The number of sheets contained in the document.

      Returns:
      possible object is String

    • setNumberOfSheets

      public void setNumberOfSheets(String value)
      Sets the value of the numberOfSheets property.
      Parameters:
      value - allowed object is String
      See Also:

    • getItemEquivalences

      public List<VecItemEquivalence> getItemEquivalences()
      Gets the value of the itemEquivalences property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the itemEquivalences property.

      For example, to add a new item, do as follows: 

          getItemEquivalences().add(newItem);

      Objects of the following type(s) are allowed in the list VecItemEquivalence

      Returns:
      The value of the itemEquivalences property.

    • getSheetOrChapters

      public List<VecSheetOrChapter> getSheetOrChapters()
      Gets the value of the sheetOrChapters property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the sheetOrChapters property.

      For example, to add a new item, do as follows: 

          getSheetOrChapters().add(newItem);

      Objects of the following type(s) are allowed in the list VecSheetOrChapter

      Returns:
      The value of the sheetOrChapters property.

    • getSpecifications

      public List<VecSpecification> getSpecifications()
      Gets the value of the specifications property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the specifications property.

      For example, to add a new item, do as follows: 

          getSpecifications().add(newItem);

      Objects of the following type(s) are allowed in the list VecSpecification

      Specified by:
      getSpecifications in interface HasSpecifications<VecSpecification>
      Returns:
      The value of the specifications property.

    • getReferencedPart

      public List<VecPartVersion> getReferencedPart()
      Gets the value of the referencedPart property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the referencedPart property.

      For example, to add a new item, do as follows: 

          getReferencedPart().add(newItem);

      Objects of the following type(s) are allowed in the list Object

    • getRelatedDocument

      public List<VecDocumentVersion> getRelatedDocument()
      Gets the value of the relatedDocument property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the relatedDocument property.

      For example, to add a new item, do as follows: 

          getRelatedDocument().add(newItem);

      Objects of the following type(s) are allowed in the list Object

    • getRefDocumentVersion

      public Set<VecDocumentVersion> getRefDocumentVersion()
      Gets a Set of all VecDocumentVersion that have a outgoing reference to this object.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • getRefDocumentBasedInstruction

      public Set<VecDocumentBasedInstruction> getRefDocumentBasedInstruction()
      Gets a Set of all VecDocumentBasedInstruction that have a outgoing reference to this object.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • getRefExternalMappingSpecification

      public Set<VecExternalMappingSpecification> getRefExternalMappingSpecification()
      Gets a Set of all VecExternalMappingSpecification that have a outgoing reference to this object.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • getParentVecContent

      public VecContent getParentVecContent()
      Gets a reference to the parent of this object in the XML DOM Tree. If this class can have different parents in DOM, this property is initialized with the parent, if the parent is a VecContent otherwise it will be null.
      Warning!: This is a readonly property! It has to be initialized during the unmarshalling process by the ExtendedUnmarshaller.
      This property is consistent to the state of object model at the time of unmarshalling. It does not reflect any changes done in the object model after the unmarshalling.
      This property has no effect when the object is marshalled to xml.

    • accept

      public <R, E extends Throwable> R accept(Visitor<R,E> aVisitor) throws E
      Specified by:
      accept in interface Visitable
      Throws:
      E extends Throwable