Class ArtifactName
This abstract class represents the name of an artifact.
public class ArtifactName
Hierarchical Diagram
Direct Known Subclasses
None
Constructor
None
Methods
• getSerialPart
Returns a string of serial numbers that is used to replace the longest sequence of the character # in the name of an artifact.
public static String getSerialPart(Artifact art)
Where:
art—The artifact selected in the design.
Throws: RSDException
• getSerialPart
Returns a string of serial numbers that is used to replace the longest sequence of the character # in the name of the shape of the artifact.
public static String getSerialPart(Shape shape)
Where:
shape—The shape of the selected artifact that appears on the design sheet.
Throws: RSDException
• slice
Returns a substring of the name of the artifact.
public static String slice(Artifact art, int sFrom, int sTo)
Where:
art—The artifact selected in the design.
sFrom—Indicates where the substring starts from in the name of the artifact.
sTo—Indicates where the substring ends in the name of the artifact.
Throws: RSDException
• slice
Returns a substring of the name of the Artifact of the supplied shape.
public static String slice(Shape shape, int sFrom, int sTo)
Where:
shape—The shape from which the Artifact will be obtained.
sFrom—Indicates where the substring starts from in the name of the shape of the artifact.
sTo—Indicates where the substring ends in the name of the shape of the artifact.
Throws: RSDException
• slice
Returns a substring either from the left or right of the name of the artifact.
Public static String slice(Artifact art, int sNumChars)
Where:
art—The artifact selected in the design.
sNumChars—Indicates the number of characters that must be returned as the substring. If sNumChars is positive, the substring is taken from the left side of the name of the artifact. If sNumChars is negative, the substring is taken from the right side of the name of the artifact.
Throws: RSDException
• slice
Returns a substring either from the left or right of the name of the Artfact of the supplied shape.
public static String slice(Shape shape, int sNumChars)
Where:
shape—The shape of the selected artifact that appears on the design sheet.
sNumChars—Indicates the number of characters that must be returned as the substring. If sNumChars is positive, the substring is taken from the left side of the name of the shape. If sNumChars is negative, the substring is taken from the right side of the name of the shape.
Throws: RSDException
• getNthWord
Returns the nth character in the name of the artifact.
Public static String getNthWord(Artifact art, int sWordIdx, char sDelims)
Where:
art—The artifact selected in the design.
sWordIdx—Indicates the index of the required character.
sDelims—Indicates the string of characters that must be treated as delimiters while searching for the nth character.
Throws: RSDException
• getNthWord
Returns the nth character in the name of the Artifact of the supplied shape.
public static String getNthWord(Shape shape, int sWordIdx, char sDelims)
Where:
shape—The shape from which the Artifact will be obtained.
sWordIdx—Indicates the index of the required character.
sDelims—Indicates the string of characters that must be treated as delimiters while searching for the nth character.
Throws: RSDException
Methods Inherited
None
