|
|
Package com.dassault_systemes.catweb.databackend.dataType |
Class PELeaf
|
Class Hierarchy |
java.lang.Object | +-com.dassault_systemes.catweb.databackend.dataType.PELeaf
Class Location |
Class Description |
public class PELeaf
Class to expose a final data of your system in the Portal Product Explorer.
All Implemented Interfaces: Cloneable
Field Summary |
String | separator_string |
int | Metadata |
int | Document |
int | Nearest |
Constructor Summary |
PELeaf(Uuid iUuid, PEType iType) |
Method Summary |
void | setAttributeValues(String[] iAttributeValues) |
String[] | getAttributeValues() |
PEAttribute[] | getAttributes() |
String | getName() |
void | setName(String iName) |
void | setType(PEType iType) |
PEType | getType() |
void | setUuid(Uuid iUuid) |
Uuid | getUuid() |
Object | getInternalProperty(String iProperty) |
void | removeInternalProperty(String iProperty) |
void | putInternalProperty(String iProperty, String iValue) |
void | setDocument(Document iDocument) |
Document | getDocument() |
boolean | containsString(String[] search) |
String | getExtension() |
void | setExtension(String iExtension) |
void | addDynamicProperty(KeywordValue _kw) |
KeywordValue[] | getDynamicProperties() |
void | removeDynamicProperties() |
KeywordValue[] | getProperties() |
Object | clone() |
PELeaf | PELeafClone() |
void | CopyInto(PELeaf peLeafDest) |
Field Detail |
String separator_string
int Metadata
int Document
int Nearest
Constructor Detail |
PELeaf(Uuid iUuid, PEType iType)Constructs a PELeaf given its identifier and its type.
iUuid
iType
Method Detail |
void setAttributeValues(String[] iAttributeValues)Sets the values of the PEAttribute.
iAttributeValues
String[] getAttributeValues()Returns the values of the PEAttribute as an array of String Object. Each String is the value of the PEAttribute, in with the same order as the order used to set the attributes in the PEType.
PEAttribute[] getAttributes()Returns the attributes of the PELeaf or PENode as an array of PEAttribute Object.
String getName()Returns the name of the Object. Two cases :
void setName(String iName)Sets a name to the Object.
iName
void setType(PEType iType)Sets the type of the PELeaf or PENode.
iType
PEType getType()Returns the PEType of the PELeaf or PENode.
void setUuid(Uuid iUuid)Set the Uuid which is the unique identifier of the Object.
iUuid
Uuid getUuid()Returns the Uuid Object containing at least: a String representing the identifier and a String representing the environment.
Object getInternalProperty(String iProperty)Returns the String Object representing the value associated to the property.
iProperty
void removeInternalProperty(String iProperty)Removes the property and its value. Important in order to maintain the memory consumption low.
iProperty
void putInternalProperty(String iProperty, String iValue)Enables to add information that will not be seen by the user.
iProperty
iValue
void setDocument(Document iDocument)Sets the document to the PELaf. It automatically calculates the extension by taking the extension of the document and calling setExtension.
iDocument
Document getDocument()Returns the document associated. If it has not been postionned, null is returned.
boolean containsString(String[] search)
String getExtension()Returns the extension of the document. If it has not been postionned it returns the String "none".
void setExtension(String iExtension)Sets the extension of the document.
iExtension
void addDynamicProperty(KeywordValue _kw)Adds dynamicaly attributes to a PELeaf or PENode.
iKeywordValue
KeywordValue[] getDynamicProperties()Returns the dynamic attributes of a PELeaf or PENode.
void removeDynamicProperties()Removes the dynamic attributes of a PELeaf or PENode.
KeywordValue[] getProperties()Returns all the properties of the object, the ones always set with the setAttributeValues method and the additionals set with the addDynamicProperty method.
Object clone()
PELeaf PELeafClone()
void CopyInto(PELeaf peLeafDest)Copies the current leaf attributes to the given leaf
peLeafDest