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
boolean isUIDFormat(String iUid)
PortalUID getPortalUID(String iAdapter, String iEnvironment, String iId, String iType)
PortalUID getPortalUID(String iPortalUIDString)
void addParameter(String iKey, String iValue)
Hashtable extractParameters()
String getAdapter()
String getEnvironment()
String getID()
String getType()
String getExtension()
boolean isParameters()
int hashCode()
boolean equals(Object iUid)
String toString()
String toStringWithoutParameters()


Field Detail

Constructor Detail

Method Detail

isUIDFormat

    boolean isUIDFormat(String iUid)

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

Parameters:
iUid
- the potential UID
Returns:
boolean

getPortalUID

    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)

getPortalUID

    PortalUID getPortalUID(String iPortalUIDString)

Returns a PortalUID object from its string representation

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

addParameter

    void addParameter(String iKey, String iValue)

Adds a parameter to the the PortalUID

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

extractParameters

    Hashtable extractParameters()

Returns all the parameters

Returns:
java.util.Hashtable

getAdapter

    String getAdapter()

Returns the Adapter ID

Returns:
java.lang.String

getEnvironment

    String getEnvironment()

Returns the Environment ID

Returns:
java.lang.String

getID

    String getID()

Returns the ID

Returns:
java.lang.String

getType

    String getType()

Returns the Type

Returns:
java.lang.String

getExtension

    String getExtension()

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

Returns:
java.lang.String

isParameters

    boolean isParameters()

Returns true if the portalUID contains parameters else false

Returns:
boolean

hashCode

    int hashCode()

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

Returns:
int

equals

    boolean equals(Object iUid)

Indicates whether some other object is equal to this one

Parameters:
iUid
- the other PortalUID
Returns:
boolean

toString

    String toString()

Returns the string representation of the PortalUID

Returns:
java.lang.String

toStringWithoutParameters

    String toStringWithoutParameters()

Return the string representation of the PortalUID without the optionals parameters

Returns:
java.lang.String


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