|
|
|||||
| 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 |
| public static final int | Document
|
| public static final int | Metadata
|
| public static final int | Nearest
|
| protected static String | separator_string
|
| Constructor Summary |
| PELeaf(Uuid iUuid, PEType iType)
Constructs a PELeaf given its identifier and its type. |
| Method Summary |
| public void | addDynamicProperty(KeywordValue _kw)
Adds dynamicaly attributes to a PELeaf or PENode. |
| public Object | clone()
|
| public boolean | containsString(String[] search)
|
| public void | CopyInto(PELeaf peLeafDest)
Copies the current leaf attributes to the given leaf |
| public PEAttribute[] | getAttributes()
Returns the attributes of the PELeaf or PENode as an array of PEAttribute Object. |
| public String[] | getAttributeValues()
Returns the values of the PEAttribute as an array of String Object. |
| public Document | getDocument()
Returns the document associated. |
| public KeywordValue[] | getDynamicProperties()
Returns the dynamic attributes of a PELeaf or PENode. |
| public String | getExtension()
Returns the extension of the document. |
| public Object | getInternalProperty(String iProperty)
Returns the String Object representing the value associated to the property. |
| public String | getName()
Returns the name of the Object. |
| public 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. |
| public PEType | getType()
Returns the PEType of the PELeaf or PENode. |
| public Uuid | getUuid()
Returns the Uuid Object containing at least: a String representing the identifier and a String representing the environment. |
| public PELeaf | PELeafClone()
|
| public void | putInternalProperty(String iProperty, String iValue)
Enables to add information that will not be seen by the user. |
| public void | removeDynamicProperties()
Removes the dynamic attributes of a PELeaf or PENode. |
| public void | removeInternalProperty(String iProperty)
Removes the property and its value. |
| public void | setAttributeValues(String[] iAttributeValues)
Sets the values of the PEAttribute. |
| public void | setDocument(Document iDocument)
Sets the document to the PELaf. |
| public void | setExtension(String iExtension)
Sets the extension of the document. |
| public void | setName(String iName)
Sets a name to the Object. |
| public void | setType(PEType iType)
Sets the type of the PELeaf or PENode. |
| public void | setUuid(Uuid iUuid)
Set the Uuid which is the unique identifier of the Object. |
| Field Detail |
public static final int Document
public static final int Metadata
public static final int Nearest
protected static String separator_string
| Constructor Detail |
PELeaf(Uuid iUuid, PEType iType)
Constructs a PELeaf given its identifier and its type.
iUuidiType| Method Detail |
public void addDynamicProperty(KeywordValue _kw)
Adds dynamicaly attributes to a PELeaf or PENode.
iKeywordValue
public Object clone()
public boolean containsString(String[] search)
public void CopyInto(PELeaf peLeafDest)
Copies the current leaf attributes to the given leaf
peLeafDest
public PEAttribute[] getAttributes()
Returns the attributes of the PELeaf or PENode as an array of PEAttribute Object.
public 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.
public Document getDocument()
Returns the document associated.
If it has not been postionned, null is returned.
public KeywordValue[] getDynamicProperties()
Returns the dynamic attributes of a PELeaf or PENode.
public String getExtension()
Returns the extension of the document.
If it has not been postionned it returns the String "none".
public Object getInternalProperty(String iProperty)
Returns the String Object representing the value associated to the property.
iProperty
public String getName()
Returns the name of the Object.
Two cases :
public 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.
public PEType getType()
Returns the PEType of the PELeaf or PENode.
public Uuid getUuid()
Returns the Uuid Object containing at least: a String representing the identifier and a String representing the environment.
public PELeaf PELeafClone()
public void putInternalProperty(String iProperty, String iValue)
Enables to add information that will not be seen by the user.
iPropertyiValue
public void removeDynamicProperties()
Removes the dynamic attributes of a PELeaf or PENode.
public void removeInternalProperty(String iProperty)
Removes the property and its value.
Important in order to maintain the memory consumption low.
iProperty
public void setAttributeValues(String[] iAttributeValues)
Sets the values of the PEAttribute.
iAttributeValues
public 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
public void setExtension(String iExtension)
Sets the extension of the document.
iExtension
public void setName(String iName)
Sets a name to the Object.
iName
public void setType(PEType iType)
Sets the type of the PELeaf or PENode.
iType
public void setUuid(Uuid iUuid)
Set the Uuid which is the unique identifier of the Object.
iUuid