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

public interface IPropertyPDP

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	consumerTypeToProvider(URI type) PDP interface for converting from passed by consumer (presented) values to what is correct for storage or relaying on to another Context Provider.
Iterator	consumerTypeToProviders(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.
Object	consumerValueToProvider(URI consumerType, URI providerType, Object 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	providerTypeToConsumer(URI type) Helper PDP for converting from stored or child Context Provider to consumer presented value.
Object	providerValueToConsumer(URI providerType, URI consumerType, Object providerValue) Helper PDP for converting from stored or child Context Provider to consumer presented value.

Method Detail

consumerTypeToProvider

public URI consumerTypeToProvider(URI type)
                           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:

type - The consumer or unmapped type of the property value

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

consumerTypeToProviders

public Iterator consumerTypeToProviders(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 type of the property value

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 type)
                           throws org.eclipse.higgins.idas.api.IdASException

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

Parameters:

type - The actual or provider type of the property value

Returns:

The consumer or mapped 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

consumerValueToProvider

public Object consumerValueToProvider(URI consumerType,
                                      URI providerType,
                                      Object 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 property value

providerType - The actual or provider type of the property 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 Object providerValueToConsumer(URI providerType,
                                      URI consumerType,
                                      Object 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 property value

consumerType - The consumer or mapped type of the property 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