Class Artifact
This abstract class represents a named PropertySet that can be depicted on a sheet by a shape.
public class Artifact
extends PropertySet
Hierarchical Diagram
Direct Known Subclasses
• Component
• Port
Constructor
Artifact()
Methods
• getName
Returns the name of the artifact, or null if it has no name.
public String getName()
Throws: RSDException
• getShapes
Returns an iterator of all the shapes of the artifact. Each element in the iterator is a one-element array that contains shape related information.
public Iterator getShapes()
Throws: RSDException
• getContainer
Returns the container of the artifact, or null if the artifact has no container.
public Component getContainer()
Throws: RSDException
• getTopLevelContainer
Returns the top level container of the artifact, or null if the artifact has no container.
public Component getTopLevelContainer()
Throws: RSDException
• getFullName
Returns the name of the artifact.
public String setFullName()
Throws: RSDException
• setNameFree
Formats the name of the artifact using a specified format.
public String setNameFree(String freeName)
Where:
freeName—The name of the artifact.
Throws: RSDException
• setNameSerial
Formats the name of the artifact using the specified integer.
public String setNameSerial(int serialnumber)
Where:
serialnumber—Integer used to format the name on the artifact.
Throws: RSDException
• setNameAuto
Automatically assigns a unique serial number to the name of the artifact.
public String setNameAuto()
Throws: RSDException
• setNameNull
Resets the name of the artifact to null.
public String setNameNull()
Throws: RSDException
• getNameSerialNumber
Returns the format type of the name of the artifact.
If the function returns a positive number, a serial number is used to generate the name of the artifact.
If the function returns 0, the format of the name of the artifact is free format.
If the function returns a negative number, the name of the artifact is null.
public int getNameSerialNumber(StringBuffer nameFormat)
Where:
nameFormat—A string buffer specifying the format of the name of the artifact.
Throws: RSDException
• getNameFormat
Returns the format of the name of the artifact.
public String getNameFormat()
Throws: RSDException
• setNameFormat
Sets the format of the name of the artifact to the specified free format.
public String setNameFormat(String newNameFormat)
Where:
newNameFormat—A string buffer specifying the new free format to be applied to the name of the artifact.
Throws: RSDException
• getShapesVector
Returns a vector of the shapes that represent the artifact in the design.
public Vector getShapesVector()
Throws: RSDException
• getPrototype
Returns the prototype of the artifact. Returns null if the artifact is itself a prototype.
public Artifact getPrototype()
Throws: RSDException
• hasInstances
Returns true if the artifact has instances.
public boolean hasInstances()
Throws: RSDException
• getInstances
Returns the number of instances of the artifact. Returns an empty iterator if the artifact is not a prototype.
public Iterator getInstances()
Throws: RSDException
• getInstanceVector
Returns a vector of the instances of the artifact. Returns an empty vector if the artifact is not a prototype.
public Vector getInstanceVector()
Throws: RSDException
• getReferencedDatasets
Returns the number of datasets referenced by the artifact.
public Iterator getReferencedDatasets()
Throws: RSDException
• getReferencedDatasetsVector
Returns a vector of the datasets referenced by the artifact.
public Vector getReferencedDatasetsVector()
Throws: RSDException
• getDatatable
Returns the datatable associated with this artifact.
public Datatable getDatatable()
Throws: RSDException
Methods Inherited
The methods inherited from other classes are:
Class | Methods Inherited |
rsdesigner.design.PropertySet | getIntegerProperty, getProperties, getProperty, getRealProperty, getStringProperty, getType |
java.lang.Object | equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
