Package com.dassault_systemes.catweb.databackend.dataType

   
Class PELeaf

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.catweb.databackend.dataType.PELeaf
Class Location

Framework : CATJDataAccessBasicModel

Module : PLAdatabackend

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

separator_string

    String separator_string


Metadata

    int Metadata


Document

    int Document


Nearest

    int Nearest


Constructor Detail

PELeaf

    PELeaf(Uuid iUuid, PEType iType)

Constructs a PELeaf given its identifier and its type.

Parameters:
iUuid
The Uuid of the Object
iType
The PEType of the object

Method Detail

setAttributeValues

    void setAttributeValues(String[] iAttributeValues)

Sets the values of the PEAttribute.

Parameters:
iAttributeValues
An array of String Object. Each String is the value of the PEAttribute. The array has to be fill in with the same order as the order used to set the attributes in the PEType.

getAttributeValues

    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.


getAttributes

    PEAttribute[] getAttributes()

Returns the attributes of the PELeaf or PENode as an array of PEAttribute Object.


getName

    String getName()

Returns the name of the Object. Two cases :
  1. if it has been set by setName, this value is returned
  2. if not, the value is calculated according the attributes values visible in the Portal Product Explorer


setName

    void setName(String iName)

Sets a name to the Object.

Parameters:
iName
A String Object representing the name.

setType

    void setType(PEType iType)

Sets the type of the PELeaf or PENode.

Parameters:
iType
The PEType of the object.

getType

    PEType getType()

Returns the PEType of the PELeaf or PENode.


setUuid

    void setUuid(Uuid iUuid)

Set the Uuid which is the unique identifier of the Object.

Parameters:
iUuid
The Uuid of the Object.

getUuid

    Uuid getUuid()

Returns the Uuid Object containing at least: a String representing the identifier and a String representing the environment.


getInternalProperty

    Object getInternalProperty(String iProperty)

Returns the String Object representing the value associated to the property.

Parameters:
iProperty
The String Object representing the name of the property.

removeInternalProperty

    void removeInternalProperty(String iProperty)

Removes the property and its value. Important in order to maintain the memory consumption low.

Parameters:
iProperty
The String Object representing the name of the property.

putInternalProperty

    void putInternalProperty(String iProperty, String iValue)

Enables to add information that will not be seen by the user.

Parameters:
iProperty
The String Object representing the name of the property.
iValue
The String Object representing the value of the property.

setDocument

    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.

Parameters:
iDocument

getDocument

    Document getDocument()

Returns the document associated. If it has not been postionned, null is returned.


containsString

    boolean containsString(String[] search)


getExtension

    String getExtension()

Returns the extension of the document. If it has not been postionned it returns the String "none".


setExtension

    void setExtension(String iExtension)

Sets the extension of the document.

Parameters:
iExtension
????????????ou est la liste des extensions

addDynamicProperty

    void addDynamicProperty(KeywordValue _kw)

Adds dynamicaly attributes to a PELeaf or PENode.

Parameters:
iKeywordValue
The KeywordValue contains the name (keyword) and the value of this new attribute.

getDynamicProperties

    KeywordValue[] getDynamicProperties()

Returns the dynamic attributes of a PELeaf or PENode.

Returns:
An array of KeywordValue, each KeywordValue containing the name (Keyword) and the value of the property.

removeDynamicProperties

    void removeDynamicProperties()

Removes the dynamic attributes of a PELeaf or PENode.


getProperties

    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.

Returns:
An array of KeywordValue, each KeywordValue containing the name (Keyword) and the value of the property.

clone

    Object clone()


PELeafClone

    PELeaf PELeafClone()


CopyInto

    void CopyInto(PELeaf peLeafDest)

Copies the current leaf attributes to the given leaf

Parameters:
peLeafDest
The target leaf


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