Package com.dassault_systemes.catweb.documents

   
Class CDMDocument

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.catweb.documents.Document
        |
        +-com.dassault_systemes.catweb.documents.DocumentV4
              |
              +-com.dassault_systemes.catweb.documents.CDMDocument
Class Location

Framework : PortalBase

Module : PLBdocuments

Class Description

public class CDMDocument

This class represents a V4 CDM Document
It can be use to represent either a model in an assembly or a model from a database
A CDMDocument is defined by a dbname, a catab and a caenv for its access in the database
a compid and a coid for its reference in the database eventually a matrix for its positionnement

Field Summary
protected String caenv
The caenv of the document for its access in database.
protected String catab
The catab of the document for its access in database.
protected byte[] coid
The coid of the document for its database reference
protected byte[] compid
The compid for the document for its database reference
protected String dbname
The dbname of the document in the database.

Constructor Summary
CDMDocument(byte[] _uuid, String _name, int _mnum, int _jmodelo, String _dbname, float[] _mat, byte[] _coid, byte[] _compid, String _caenv, String _catab)
CDMDocument(byte[] _uuid, String _name, int _mnum, int _jmodelo, String _dbname, double[] _mat, byte[] _coid, byte[] _compid, String _caenv, String _catab)
Constructor with full parameters.
CDMDocument(String dbname, float[] mat, byte[] coid, byte[] compid, String caenv, String catab)
CDMDocument(String dbname, double[] mat, byte[] coid, byte[] compid, String caenv, String catab)
Constructor with CDM data access parameters.
CDMDocument(CDMDocument d)
Copy Constructor
CDMDocument(byte[] coid, byte[] compid, String caenv, String catab)
Constructor used when the model is in an assembly

Method Summary
public String getCaenv()
Returns the catenv of the document.
public String getCatab()
Returns the catab of the document.
public byte[] getCoid()
Returns the coid of the document.
public byte[] getCompid()
Returns the compid of the document.
public String getDbname()
Returns the dbname of the document.
public float[] getMatrix()
Returns the positionement matrix of the document.
public double[] getTransformation()
public boolean isEqual(Object document)
Compares the equality of an object with this instance
public void setTransformation(double[] mat)
public String toString()
Constructs and returns a string representation of this CDMDocument.


Field Detail

caenv

    protected String caenv
The caenv of the document for its access in database.


catab

    protected String catab
The catab of the document for its access in database.


coid

    protected byte[] coid
The coid of the document for its database reference


compid

    protected byte[] compid
The compid for the document for its database reference


dbname

    protected String dbname
The dbname of the document in the database.


Constructor Detail

CDMDocument

    CDMDocument(byte[] _uuid, String _name, int _mnum, int _jmodelo, String _dbname, float[] _mat, byte[] _coid, byte[] _compid, String _caenv, String _catab)

Parameters:
_uuid
- the uuid of the document.
_name
- the name of the document.
_mnum
- the mnum of the document.
_jmodelo
- the jmodelo of the document.
_dbname
- the dbname ofthe document in the databse.
_mat
- the matrix for the position of the document in the scene.
_coid
- the coid of the document in the database.
_compid
- the compid of the document in the database.
_caenv
- the caenv of the document in the database.
_catab
- the catab of the document in the database.

CDMDocument

    CDMDocument(byte[] _uuid, String _name, int _mnum, int _jmodelo, String _dbname, double[] _mat, byte[] _coid, byte[] _compid, String _caenv, String _catab)

Constructor with full parameters.
Usually used when the model is in a CDM database.

Parameters:
_uuid
- the uuid of the document.
_name
- the name of the document.
_mnum
- the mnum of the document.
_jmodelo
- the jmodelo of the document.
_dbname
- the dbname ofthe document in the databse.
_mat
- the matrix for the position of the document in the scene.
_coid
- the coid of the document in the database.
_compid
- the compid of the document in the database.
_caenv
- the caenv of the document in the database.
_catab
- the catab of the document in the database.

CDMDocument

    CDMDocument(String dbname, float[] mat, byte[] coid, byte[] compid, String caenv, String catab)


CDMDocument

    CDMDocument(String dbname, double[] mat, byte[] coid, byte[] compid, String caenv, String catab)

Constructor with CDM data access parameters.


CDMDocument

    CDMDocument(CDMDocument d)

Copy Constructor

Parameters:
d
- the CDMDocument to copy.

CDMDocument

    CDMDocument(byte[] coid, byte[] compid, String caenv, String catab)

Constructor used when the model is in an assembly

Parameters:
coid
- the coid of the document in the database.
compid
- the compid of the document in the database.
caenv
- the caenv of the document in the database.
catab
- the catab of the document in the database.

Method Detail

getCaenv

    public String getCaenv()

Returns the catenv of the document.


getCatab

    public String getCatab()

Returns the catab of the document.


getCoid

    public byte[] getCoid()

Returns the coid of the document.


getCompid

    public byte[] getCompid()

Returns the compid of the document.


getDbname

    public String getDbname()

Returns the dbname of the document.


getMatrix

    public float[] getMatrix()

Returns the positionement matrix of the document.


getTransformation

    public double[] getTransformation()


isEqual

    public boolean isEqual(Object document)

Compares the equality of an object with this instance

Parameters:
document
- the document to compare with this instance

setTransformation

    public void setTransformation(double[] mat)


toString

    public String toString()

Constructs and returns a string representation of this CDMDocument.



Copyright © 2000, Dassault Systèmes. All rights reserved