Package com.dassault_systemes.catweb.databackend.dataType

   
Class PEAttribute

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

Framework : CATJDataAccessBasicModel

Module : PLAdatabackend

Class Description

public class PEAttribute

Class representing an attribute of a PEType. For example if a type "car" is defined, this type could have the attribute "version", "color" and "number of door".

Field Summary
public static final int FORMAT_DATE
public static final int FORMAT_INT
public static final int FORMAT_STRING

Constructor Summary
PEAttribute(String iName, String iAlias, PEType iType, int iFormat)
Constructs the attribute of a PELeaf.

Method Summary
public String getAlias()
Returns a String Object representing the name of the PEAttribute for the user.
public String[] getAuthorizedValues()
Returns the values that the operand can have if an Extended Query is performed.
public int getformatValue()
Returns the format (String, integer, ...
public String[] getHelpValues()
Returns an array of String, containing the operand values, proposed for matching with the PEAttribute if an Extended Query is performed.
public String getName()
Returns a String Object representing the unique identifier of the PEAttribute.
public String[] getOperators()
Returns an array of String, containing the operators that can be applied to this PEAttribute if an Extended Query is performed.
public int getTreeVisibility()
Returns an integer indicating the visibility of the PEAttribute in the Portal Product Explorer.
public PEType getType()
Returns the PEType Object to which the PEAttribute is tied.
public void setAlias(String iAllias)
Sets the name of the PEAttribute for the user.
public void setAuthorizedValues(String[] iAuthorizedValues)
Sets the values that the operand can have during an Extended Query.
public void setformatValue(int iFormat)
Sets the format (String, integer, ...
public void setHelpValues(String[] iHelpValues)
Sets the operand proposed for matching with the PEAttribute during an Extended Query.
public void setName(String iName)
Sets the unique identifier of the PEAttribute.
public void setOperators(String[] iOperators)
Sets the operators that can be applied on the PEAttribute during an Extended Query.
public void setTreeVisibility(int iTreeVisibility)
Tells what is the visibility of the PEAttribute.
public void setType(PEType iType)
Sets the type to which the PEAttribute is tied.


Field Detail

FORMAT_DATE

    public static final int FORMAT_DATE


FORMAT_INT

    public static final int FORMAT_INT


FORMAT_STRING

    public static final int FORMAT_STRING

See Also:
getformatValue

Constructor Detail

PEAttribute

    PEAttribute(String iName, String iAlias, PEType iType, int iFormat)

Constructs the attribute of a PELeaf.

Parameters:
iName
The String Object representing the unique identifier of the PEAttribute.
iAlias
The String Object representing the name of the attribute for the user.
iType
The PEType to which the PEAttribute is tied.
iFormat
The format of the attribute : 0, 1, 2, ... corresponding to String, int, ... for now, the only solution is 0, the attribute is a String.
See Also:
FORMAT_STRING
FORMAT_INT

Method Detail

getAlias

    public String getAlias()

Returns a String Object representing the name of the PEAttribute for the user.


getAuthorizedValues

    public String[] getAuthorizedValues()

Returns the values that the operand can have if an Extended Query is performed.


getformatValue

    public int getformatValue()

Returns the format (String, integer, ... ) of the PEAttribute. The int Object 0, corresponding to a java.lang.String is the only available format in the curent code version.

See Also:
FORMAT_STRING
FORMAT_INT

getHelpValues

    public String[] getHelpValues()

Returns an array of String, containing the operand values, proposed for matching with the PEAttribute if an Extended Query is performed.


getName

    public String getName()

Returns a String Object representing the unique identifier of the PEAttribute.


getOperators

    public String[] getOperators()

Returns an array of String, containing the operators that can be applied to this PEAttribute if an Extended Query is performed.


getTreeVisibility

    public int getTreeVisibility()

Returns an integer indicating the visibility of the PEAttribute in the Portal Product Explorer.

Return:
If the reterned int equals 0 the attribute isn't visible.
If the reterned int is bigger than 0, the attribute is visible, the int indicates the position in the visible name.

getType

    public PEType getType()

Returns the PEType Object to which the PEAttribute is tied.


setAlias

    public void setAlias(String iAllias)

Sets the name of the PEAttribute for the user.

Parameters:
iAlias
The String Object representing the name of the PEAttribute for the user.

setAuthorizedValues

    public void setAuthorizedValues(String[] iAuthorizedValues)

Sets the values that the operand can have during an Extended Query. If HelpValues and AuthorizedValues are specified, AuthorizedValues are prioritary.

Parameters:
iAuthorizedValues
An array of String, containing the mandatory operand, for the Extended Query.

setformatValue

    public void setformatValue(int iFormat)

Sets the format (String, integer, ... ) of the PEAttribute.

Parameters:
iFormat
The int Object 0, corresponding to a java.lang.String is the only available format in the curent code version.
See Also:
FORMAT_STRING
FORMAT_INT

setHelpValues

    public void setHelpValues(String[] iHelpValues)

Sets the operand proposed for matching with the PEAttribute during an Extended Query. The operand value are options, the user could add his own values in the Extended Query.

Parameters:
iHelpValues
An array of String, containing the operand values, proposed for matching with the PEAttribute if an Extended Query is performed.

setName

    public void setName(String iName)

Sets the unique identifier of the PEAttribute.

Parameters:
iName
The String Object representing the unique identifier of the PEAttribute.

setOperators

    public void setOperators(String[] iOperators)

Sets the operators that can be applied on the PEAttribute during an Extended Query. If no operator is specified, the PEAttribute can not be used in the Extended Query.

Parameters:
iOperators
An array of String, containing the operators that can be applied to this PEAttribute if an Extended Query is performed.

setTreeVisibility

    public void setTreeVisibility(int iTreeVisibility)

Tells what is the visibility of the PEAttribute. The name of a node in the Portal Product Explorer is defined by the concatenation of the value of all visible PEAttribute of this node.

Parameters:
iTreeVisibility
If iTreeVisibility equals 0 the attribute isn't visible.
If iTreeVisibility is bigger than 0, the attribute is visible, iTreeVisibility indicates the position in the visible name.

setType

    public void setType(PEType iType)

Sets the type to which the PEAttribute is tied.

Parameters:
iType
The PEType Object to which the PEAttribute is tied.


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