org.eclipse.higgins.util.idas.cp
Interface IAttributePDPs

All Known Implementing Classes:

JScriptCPAttributePDPs, JScriptCPMetadataPDPs

public interface IAttributePDPs

Part of a Higgins Context provider. This module defines the PDP interfaces that are common to most attribute, metadata and value based Higgins objects. Assists in mapping between consumer and provider elements

Author:

dbuss@novell.com

Method Summary

URI	consumerIDToProvider(URI consumerID) PDP interface for converting from passed by consumer (presented) attributes and their to values to what is correct for storage or relaying on to another Context Provider.
Iterator	consumerIDToProviders(URI elem) PDP interface for converting from passed by consumer (presented) values to what is correct for storage or relaying on to another Context Provider.
URI	consumerTypeToProvider(URI consumerID, URI consumerType) PDP interface for converting from passed by consumer (presented) values to what is correct for storage or relaying on to another Context Provider.
org.eclipse.higgins.idas.api.IAttributeValue	consumerValueToProvider(URI consumerID, URI consumerType, URI providerID, URI providerType, org.eclipse.higgins.idas.api.IAttributeValue consumerValue) Helper PDP for converting from passed (consumer presented/provided} value to what is correct for storage or relaying on to another Context Provider.
URI	providerIDToConsumer(URI providerID) Helper PDP for converting from stored or child Context Provider to consumer presented value.
URI	providerTypeToConsumer(URI providerID, URI providerType) Helper PDP for converting from stored or child Context Provider to consumer presented value.
org.eclipse.higgins.idas.api.IAttributeValue	providerValueToConsumer(URI providerID, URI providerType, URI consumerID, URI consumerType, org.eclipse.higgins.idas.api.IAttributeValue providerValue) Helper PDP for converting from stored or child Context Provider to consumer presented value.

Method Detail

consumerIDToProvider

public URI consumerIDToProvider(URI consumerID)
                         throws org.eclipse.higgins.idas.api.IdASException

PDP interface for converting from passed by consumer (presented) attributes and their to values to what is correct for storage or relaying on to another Context Provider.

Parameters:

consumerID - the consumer or unmapped ID of the attribute

Returns:

The actual or provider ID of the attribute value, returning null indicates that this property should not be returned to the consumer.

Throws:

org.eclipse.higgins.idas.api.IdASException

consumerIDToProviders

public Iterator consumerIDToProviders(URI elem)
                               throws org.eclipse.higgins.idas.api.IdASException

PDP interface for converting from passed by consumer (presented) values to what is correct for storage or relaying on to another Context Provider. This may return multiple values for cases where one maps to many

Parameters:

elem - The consumer or unmapped ID of the attribute

Returns:

The actual or provider type of the attribute, returning null indicates that this property should not be returned to the consumer.

Throws:

org.eclipse.higgins.idas.api.IdASException

providerIDToConsumer

public URI providerIDToConsumer(URI providerID)
                         throws org.eclipse.higgins.idas.api.IdASException

Helper PDP for converting from stored or child Context Provider to consumer presented value.

Parameters:

providerID - The actual or provider type of the attribute value

Returns:

The consumer or mapped type of the attribute value, returning null indicates that this property should not be returned to the consumer.

Throws:

org.eclipse.higgins.idas.api.IdASException

consumerTypeToProvider

public URI consumerTypeToProvider(URI consumerID,
                                  URI consumerType)
                           throws org.eclipse.higgins.idas.api.IdASException

PDP interface for converting from passed by consumer (presented) values to what is correct for storage or relaying on to another Context Provider.

Parameters:

consumerID - the consumer or unmapped ID of the attribute

consumerType - The consumer or unmapped type of the attribute

Returns:

The actual or provider type of the property value, returning null indicates that this property should not be returned to the consumer.

Throws:

org.eclipse.higgins.idas.api.IdASException

providerTypeToConsumer

public URI providerTypeToConsumer(URI providerID,
                                  URI providerType)
                           throws org.eclipse.higgins.idas.api.IdASException

Helper PDP for converting from stored or child Context Provider to consumer presented value.

Parameters:

providerID - the provider id of the attribute value

providerType - The actual or provider type of the attribute value

Returns:

The consumer or mapped type of the metadata, returning null indicates that this property should not be returned to the consumer.

Throws:

org.eclipse.higgins.idas.api.IdASException

consumerValueToProvider

public org.eclipse.higgins.idas.api.IAttributeValue consumerValueToProvider(URI consumerID,
                                                                            URI consumerType,
                                                                            URI providerID,
                                                                            URI providerType,
                                                                            org.eclipse.higgins.idas.api.IAttributeValue consumerValue)
                                                                     throws org.eclipse.higgins.idas.api.IdASException

Helper PDP for converting from passed (consumer presented/provided} value to what is correct for storage or relaying on to another Context Provider.

Parameters:

consumerType - The consumer or mapped type of the attribute value

providerType - The actual or provider type of the attribute value

consumerValue - The data comprising the consumer view of the value

Returns:

If the PDP creates a new value that will be returned, if no mapping called for then the original value should be returned. A null means this value is not to be presented to the next interface.

Throws:

org.eclipse.higgins.idas.api.IdASException

providerValueToConsumer

public org.eclipse.higgins.idas.api.IAttributeValue providerValueToConsumer(URI providerID,
                                                                            URI providerType,
                                                                            URI consumerID,
                                                                            URI consumerType,
                                                                            org.eclipse.higgins.idas.api.IAttributeValue providerValue)
                                                                     throws org.eclipse.higgins.idas.api.IdASException

Helper PDP for converting from stored or child Context Provider to consumer presented value.

Parameters:

providerType - The actual or provider type of the attribute value

consumerType - The consumer or mapped type of the attribute value

providerValue - The data stored or child Context Provider view of the value

Returns:

If the PDP creates a new value that will be returned, if no mapping called for then the original value should be returned. A null means this value is not to be presented to the next interface.

Throws:

org.eclipse.higgins.idas.api.IdASException