Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.0.0)

E10653-01

oracle.adf.model
Interface PageMap

All Superinterfaces:
java.util.Map<java.lang.String,java.lang.String>
All Known Implementing Classes:
DefaultPageMapImpl, DynamicPageMapImpl

public interface PageMap
extends java.util.Map<java.lang.String,java.lang.String>

The PageMap interface is used by ADFm to map a page URL to a BindingContainer usage name. The mapping will be used by ADFm to establish the current 'bindings' context when a page is visited.

Application developers may specify that ADFm use a custom PageMap implementation by specifying a 'PageMapClass' attribute in their binding application definition (cpx file). A custom PageMap may be used to specify dynamic mappings that are not defined statically in the ADFm application definition.

ADFm will also use the PageMap to map a page URL to page defintion names. getDefinitionName(String, String) supports the URL to definition mappings. The URL to definition mapping is used by ADFm to create a BindingContainer instance when the BindingContainer is requested.

Since:
release specific (what release of product did this appear in)

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Method Summary
 java.lang.String addDefinitionNameForUsage(java.lang.String usageName, java.lang.String defintionName)
          Map a BindingContainer usage name to a page defintion name.
 java.lang.String getDefinitionName(java.lang.String url, java.lang.String basePackageName)
          Return a page definition name for the specified page URL.
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

getDefinitionName

java.lang.String getDefinitionName(java.lang.String url,
                                   java.lang.String basePackageName)
Return a page definition name for the specified page URL. The basePackageName is the BasePageDefPackageName that is specified in the application definition (cpx) that defined this PageMap. If a BasePageDefPackageName is not defined then the packageName is the package of the application definition that defined this PageMap.

If a not-null definition is returned then ADFm will use the definition to generate a BindingContainer instance. A null return indicates that no BindingContainer instance may be created for the specified URL.

Parameters:
url - a page URL
basePackageName - the base page definition package name
Returns:
a page definition name

addDefinitionNameForUsage

java.lang.String addDefinitionNameForUsage(java.lang.String usageName,
                                           java.lang.String defintionName)
Map a BindingContainer usage name to a page defintion name.

Parameters:
usageName - a BindingContainer usage name
definitonName - a page definition name
Returns:
the value of the existing mapping for the usage name

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.0.0)

E10653-01

Copyright © 1997, 2008, Oracle. All rights reserved.