Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.1.0)

E17483-02

oracle.jbo.uicli.mom
Class DynamicPageMapImpl

java.lang.Object
  extended by oracle.jbo.uicli.mom.DefaultPageMapImpl
      extended by oracle.jbo.uicli.mom.DynamicPageMapImpl
All Implemented Interfaces:
java.util.Map<java.lang.String,java.lang.String>, PageMap

public class DynamicPageMapImpl
extends DefaultPageMapImpl

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>
 
Field Summary
protected  java.util.regex.Pattern mURLPattern
           
 
Fields inherited from class oracle.jbo.uicli.mom.DefaultPageMapImpl
isCachingInBCtx
 
Constructor Summary
DynamicPageMapImpl()
          WARNING: The default pattern is not suitable for a multi-cpx application.
DynamicPageMapImpl(java.lang.String patternStr)
          WARNING: The default pattern is not suitable for a multi-cpx application.
 
Method Summary
 java.lang.String get(java.lang.Object url)
           
protected  java.util.Map<java.lang.String,java.lang.String> getDefinitionCache()
          A DynamicPageMapImpl may override this method to provide a custom Map implementation for managing the url -> definition mappings.
 java.lang.String getDefinitionName(java.lang.String url, java.lang.String packageName)
          Return a page definition name for the specified page URL.
protected  java.util.Map<java.lang.String,java.lang.String> getUsageCache()
          A DynamicPageMapImpl may override this method to provide a custom Map implementation for caching the url -> usage mappings.
protected  java.lang.String parsePage(java.lang.String url)
           
protected  java.lang.String parsePath(java.lang.String url)
           
protected  void setLRUCacheSize(int lruCacheSize)
           
 void setURLPattern(java.lang.String patternStr)
           
 
Methods inherited from class oracle.jbo.uicli.mom.DefaultPageMapImpl
addDefinitionNameForUsage, clear, containsKey, containsValue, entrySet, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Field Detail

mURLPattern

protected java.util.regex.Pattern mURLPattern
Constructor Detail

DynamicPageMapImpl

public DynamicPageMapImpl()
WARNING: The default pattern is not suitable for a multi-cpx application. Either use the other constructor, or call setURLPattern immediately.


DynamicPageMapImpl

public DynamicPageMapImpl(java.lang.String patternStr)
WARNING: The default pattern is not suitable for a multi-cpx application. An extends class should provide it's own 3 part matching pattern. Matches signify that this cpx "owns" pages that match the pattern. Therefore it's important not to match on pages already in other cpx's. The pattern has 3 groups and selects string like: /view1.jspx, /view1, view1.jspx, view1, /view/view1.jspx. Group 1 matches everything except the leading forward slash and the suffix (view1). Group 2 matches the page path (view/). Group 3 matches the page name.

Method Detail

setURLPattern

public void setURLPattern(java.lang.String patternStr)

setLRUCacheSize

protected void setLRUCacheSize(int lruCacheSize)

get

public java.lang.String get(java.lang.Object url)
Specified by:
get in interface java.util.Map<java.lang.String,java.lang.String>
Overrides:
get in class DefaultPageMapImpl

getUsageCache

protected java.util.Map<java.lang.String,java.lang.String> getUsageCache()
A DynamicPageMapImpl may override this method to provide a custom Map implementation for caching the url -> usage mappings. Caching the url -> usage mappings may provide performance benefits when URL parsing is expensive. DynamicPageMapImpl is not dependent upon caching and can work with any caching scheme that is selected by the custom PageMap. The only restriction is that the cache must be threadsafe. The default implementation returns null. This implies that no caching is to be performed.

Returns:
a threadsafe Map that may be used to cache the url -> usage mappings for this Map

getDefinitionCache

protected java.util.Map<java.lang.String,java.lang.String> getDefinitionCache()
A DynamicPageMapImpl may override this method to provide a custom Map implementation for managing the url -> definition mappings. Caching the url -> def mappings may provide performance benefits when URL parsing is expensive. DynamicPageMapImpl is not dependent upon caching and can work with any caching scheme that is selected by the custom PageMap. The only restriction is that the cache must be threadsafe. The default implementation returns null. This implies that no caching is to be performed.

Returns:
a threadsafe Map that may be used to cache the url -> def mappings for this Map

getDefinitionName

public java.lang.String getDefinitionName(java.lang.String url,
                                          java.lang.String packageName)
Description copied from interface: PageMap
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.

Specified by:
getDefinitionName in interface PageMap
Overrides:
getDefinitionName in class DefaultPageMapImpl
Parameters:
url - a page URL
packageName - the base page definition package name
Returns:
a page definition name

parsePage

protected java.lang.String parsePage(java.lang.String url)

parsePath

protected java.lang.String parsePath(java.lang.String url)

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.1.0)

E17483-02

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