Package com.dassault_systemes.PPRNBbase.uid

   
Class PortalUID

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.PPRNBbase.uid.PortalUID
Class Location

Framework : PPRJNavigatorBase

Module : PPRNBbase

Class Description

public class PortalUID

Class defined to : - create an universal identifier - access to Universal Identifier APIs String format : UID/Adapter/Environment/ID.Type UID is a key word identifying an universal identifier The Universal identifier supports optionnal parameters String format : UID/Adapter/Environment/ID.Type?param1=valur1¶m2=value2 To manipulate these parameters use the following methods : - addParameter - extractParameters - isParameters

Field Summary

Constructor Summary

Method Summary
public void addParameter(String iKey, String iValue)
Adds a parameter to the the PortalUID
public boolean equals(Object iUid)
Indicates whether some other object is equal to this one
public Hashtable extractParameters()
Returns all the parameters
public String getAdapter()
Returns the Adapter ID
public String getEnvironment()
Returns the Environment ID
public String getExtension()
If there is an Extension parameter, returns its value.
public String getID()
Returns the ID
public static PortalUID getPortalUID(String iPortalUIDString)
Returns a PortalUID object from its string representation
public static PortalUID getPortalUID(String iAdapter, String iEnvironment, String iId, String iType)
Returns a new PortalUID object from its Adapter, Environment, Id and Type
public String getType()
Returns the Type
public int hashCode()
Returns the hash code value for this object We don't use the parameters to calculate it
public boolean isParameters()
Returns true if the portalUID contains parameters else false
public static boolean isUIDFormat(String iUid)
Returns true if the string value is a Universal ID else false
public String toString()
Returns the string representation of the PortalUID
public String toStringWithoutParameters()
Return the string representation of the PortalUID without the optionals parameters


Field Detail

Constructor Detail

Method Detail

addParameter

    public void addParameter(String iKey, String iValue)

Adds a parameter to the the PortalUID

Parameters:
iKey
- the parameter name
iValue
- the parameter value

equals

    public boolean equals(Object iUid)

Indicates whether some other object is equal to this one

Parameters:
iUid
- the other PortalUID
Return:
boolean

extractParameters

    public Hashtable extractParameters()

Returns all the parameters

Return:
java.util.Hashtable

getAdapter

    public String getAdapter()

Returns the Adapter ID

Return:
java.lang.String

getEnvironment

    public String getEnvironment()

Returns the Environment ID

Return:
java.lang.String

getExtension

    public String getExtension()

If there is an Extension parameter, returns its value. Otherwise return the type.

Return:
java.lang.String

getID

    public String getID()

Returns the ID

Return:
java.lang.String

getPortalUID

    public static PortalUID getPortalUID(String iPortalUIDString)

Returns a PortalUID object from its string representation

Parameters:
iPortalUIDString
- the UID String representation
Return:
com.dassault_systemes.PPRNBbase.uid.PortalUID

getPortalUID

    public static PortalUID getPortalUID(String iAdapter, String iEnvironment, String iId, String iType)

Returns a new PortalUID object from its Adapter, Environment, Id and Type

Parameters:
iAdapter
- the Adapter ID (not encoded)
iEnvironment
- the Environment name (not encoded)
iId
- the Object Identifier (not encoded)
iType
- the Object Type (not encoded)

getType

    public String getType()

Returns the Type

Return:
java.lang.String

hashCode

    public int hashCode()

Returns the hash code value for this object We don't use the parameters to calculate it

Return:
int

isParameters

    public boolean isParameters()

Returns true if the portalUID contains parameters else false

Return:
boolean

isUIDFormat

    public static boolean isUIDFormat(String iUid)

Returns true if the string value is a Universal ID else false

Parameters:
iUid
- the potential UID
Return:
boolean

toString

    public String toString()

Returns the string representation of the PortalUID

Return:
java.lang.String

toStringWithoutParameters

    public String toStringWithoutParameters()

Return the string representation of the PortalUID without the optionals parameters

Return:
java.lang.String


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