org.apache.myfaces.trinidad.util.ComponentUtils Maven / Gradle / Ivy
Show all versions of trinidad-api Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.myfaces.trinidad.util;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;
import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;
import javax.faces.component.UIViewRoot;
import javax.faces.component.visit.VisitContext;
import javax.faces.context.FacesContext;
import org.apache.myfaces.trinidad.change.InsertedComponentFragmentLocator;
import org.apache.myfaces.trinidad.change.InsertingComponentFragmentLocator;
import org.apache.myfaces.trinidad.component.FlattenedComponent;
import org.apache.myfaces.trinidad.component.UIXComponent;
import org.apache.myfaces.trinidad.context.PageResolver;
import org.apache.myfaces.trinidad.context.RequestContext;
import org.apache.myfaces.trinidad.logging.TrinidadLogger;
/**
* Utility functions used by the Apache Trinidad components.
*
* @version $Name: $ ($Revision: adfrt/faces/adf-faces-api/src/main/java/oracle/adf/view/faces/util/ComponentUtils.java#0 $) $Date: 10-nov-2005.19:08:37 $
*/
public final class ComponentUtils
{
private ComponentUtils()
{
}
/**
* Utility method for component code that resolves an Object,
* returning a default value if the value is null.
*/
public static Object resolveObject(
Object value,
Object defaultValue
)
{
return (value != null)
? value
: defaultValue;
}
/**
* Utility method for component code that transforms Object->boolean.
*/
public static boolean resolveBoolean(
Object value,
boolean defaultValue
)
{
if (defaultValue)
return !Boolean.FALSE.equals(value);
else
return Boolean.TRUE.equals(value);
}
/**
* Utility method for component code that transforms Object->boolean.
*/
public static boolean resolveBoolean(
Object value
)
{
return Boolean.TRUE.equals(value);
}
/**
* Utility method for component code that transforms an Object
* (which must be a java.lang.Number) into an int.
*/
public static int resolveInteger(
Object value
)
{
return resolveInteger(value, 0);
}
/**
* Utility method for component code that transforms an Object
* (which must be a java.lang.Number) into an int.
*/
public static int resolveInteger(
Object value,
int defaultValue
)
{
return (value != null)
? ((Number)value).intValue()
: defaultValue;
}
/**
* Utility method for component code that transforms an Object
* (which must be a java.lang.Number) into a long.
*/
public static long resolveLong(
Object value
)
{
return resolveLong(value, 0);
}
/**
* Utility method for component code that transforms an Object
* (which must be a java.lang.Number) into a long.
*/
public static long resolveLong(
Object value,
long defaultValue
)
{
return (value != null)
? ((Number)value).longValue()
: defaultValue;
}
/**
* Utility method for component code that transforms an Object
* (which must be a java.lang.Number) into a double.
*/
public static double resolveDouble(
Object value
)
{
return resolveDouble(value, 0);
}
/**
* Utility method for component code that transforms an Object
* (which must be a java.lang.Number) into a double.
*/
public static double resolveDouble(
Object value,
double defaultValue
)
{
return (value != null)
? ((Number)value).doubleValue()
: defaultValue;
}
/**
* Utility method for component code that transforms Character->character.
*/
public static char resolveCharacter(
Character value
)
{
return resolveCharacter(value, '\u0000');
}
/**
* Utility method for component code that transforms Character->character.
*/
public static char resolveCharacter(
Character value,
char defaultValue
)
{
return (value != null)
? value.charValue()
: defaultValue;
}
/**
* Utility method for component code that transforms Object->Number.
*/
public static Number resolveNumber(
Object value
)
{
return resolveNumber(value, null);
}
/**
* Utility method for component code that transforms Object->Number.
*/
public static Number resolveNumber(
Object value,
Number defaultValue
)
{
return (value != null)
? (Number) value
: defaultValue;
}
/**
* Utility method for component code that transforms Object->String.
*/
public static String resolveString(
Object value
)
{
return resolveString(value, false);
}
/**
* Utility method for component code that transforms Object->String.
* If treatEmptyStringAsNull is true, null is returned for empty string.
*/
public static String resolveString(
Object value,
boolean treatEmptyStringAsNull
)
{
if (value == null)
{
return null;
}
String strValue = value.toString();
if (treatEmptyStringAsNull && strValue.trim().isEmpty())
{
return null;
}
return strValue;
}
/**
* Utility method for component code that transforms Object->String.
*/
public static String resolveString(
Object value,
String defaultValue
)
{
return (value != null)
? value.toString()
: defaultValue;
}
/**
* Utility method for code that transforms Object->String[]
*/
public static String[] resolveStringArray(
Object value)
{
return resolveStringArray(value, null);
}
/**
* Utility method for code that transforms Object->String[]
*/
public static String[] resolveStringArray(
Object value,
String[] defaultValue)
{
return (value != null)
? (String[]) value
: defaultValue;
}
/**
* Utility method for code that transforms Object->Date
*/
public static Date resolveDate(Object value)
{
return resolveDate(value, null);
}
/**
* Utility method for code that transforms Object->Date
*/
public static Date resolveDate(
Object value,
Date defaultValue)
{
return (value != null)
? (Date) value
: defaultValue;
}
public static TimeZone resolveTimeZone(
Object value
)
{
return resolveTimeZone(value, null);
}
public static TimeZone resolveTimeZone(
Object value,
TimeZone defaultValue
)
{
return (value != null)
? (TimeZone) value
: defaultValue;
}
public static Locale resolveLocale(
Object value
)
{
return resolveLocale(value, null);
}
public static Locale resolveLocale(
Object value,
Locale defaultValue
)
{
return (value != null)
? (Locale) value
: defaultValue;
}
/**
* @param visitContext
* @return true if this is a non-iterating visit.
*/
public static boolean isSkipIterationVisit(VisitContext visitContext)
{
FacesContext context = visitContext.getFacesContext();
Map attrs = context.getAttributes();
Object skipIteration = attrs.get("javax.faces.visit.SKIP_ITERATION");
return Boolean.TRUE.equals(skipIteration);
}
/**
* Gets the root cause of an exception.
* Keeps unwrapping the given throwable until the root cause is found.
*/
public static Throwable unwrap(Throwable t)
{
while(true)
{
Throwable unwrap = t.getCause();
if (unwrap == null)
break;
t = unwrap;
}
return t;
}
/**
* Find a component relative to another.
*
* The relative ID must account for NamingContainers. If the component is already inside
* of a naming container, you can use a single colon to start the search from the root,
* or multiple colons to move up through the NamingContainers - "::" will
* pop out of the current naming container, ":::" will pop out of two
* naming containers, etc.
*
*
* @param from the component to search relative to
* @param scopedId the relative id path from the 'from' component to the
* component to find
* @return the component if found, null otherwise
* @see org.apache.myfaces.trinidad.render.RenderUtils#getRelativeId
* @see javax.faces.component.UIComponent#findComponent
*/
public static UIComponent findRelativeComponent(
UIComponent from,
String scopedId)
{
if (from == null)
return null;
UIComponent originalFrom = from;
String originalRelativeId = scopedId;
int idLength = scopedId.length();
// Figure out how many colons
int colonCount = 0;
while (colonCount < idLength)
{
if (scopedId.charAt(colonCount) != NamingContainer.SEPARATOR_CHAR)
break;
colonCount++;
}
// colonCount == 0: fully relative
// colonCount == 1: absolute (still normal findComponent syntax)
// colonCount > 1: for each extra colon after 1, pop out of
// the naming container (to the view root, if naming containers run out)
if (colonCount > 1)
{
scopedId = scopedId.substring(colonCount);
// if the component is not a NamingContainer, then we need to
// get the component's naming container and set this as the 'from'.
// this way we'll pop out of the component's
// naming container if there is are multiple colons.
if (!(from instanceof NamingContainer))
{
from = _getParentNamingContainerOrViewRoot(from);
}
// pop out of the naming containers if there are multiple colons
for (int j = 1; j < colonCount; j++)
{
from = _getParentNamingContainerOrViewRoot(from);
}
}
UIComponent found = from.findComponent(scopedId);
if (found != null)
return found;
else
{
// try the old way for backward compatability as far as it differed,
// which is only if the 'from' was not a NamingContainer.
if (!(originalFrom instanceof NamingContainer))
return _findRelativeComponentDeprecated(originalFrom, originalRelativeId);
else
return null;
}
}
/**
* Gets the location (context relative path) of the document that contains the tag definition
* corresponding to the supplied component. This implementation uses the
* InsertedComponentFragmentLocator and InsertingComponentFragmentLocator strategies to determine
* the document path for the supplied component.
* All registered InsertedComponentFragmentLocator services are first asked for location of the
* document for the supplied component first. If the locator could not be obtained, then this
* implementation will walk up the component tree and for every ancestor until the view root,
* call all the registered InsertedComponentFragmentLocator and InsertingComponentFragmentLocator
* services to obtain the location of the document. If in this process any non-null value is
* obtained for the document location, the ancestor processing is halted and the value is
* returned.
*
* @param context The FacesContext instance for the current request
* @param component The component for which the document path is to be determined
* @return Location of the document fragment that contains the tag corresponding to the supplied
* component. Returns null if the path cannot be determined.
*/
public static String getDocumentLocationForComponent(
FacesContext context,
UIComponent component)
{
UIViewRoot viewRoot = context.getViewRoot();
// if we are dealing with view root, look no further
if (component == viewRoot)
{
return _getPhysicalURI(viewRoot.getViewId());
}
String location = null;
List insertedComponentFragmentLocators =
ClassLoaderUtils.__getCachableServices(InsertedComponentFragmentLocator.class);
// 1. try to get the path for the supplied component
location = _getInsertedComponentLocation(context,
insertedComponentFragmentLocators,
component,
component);
// 2. try to get the path for the supplied component using its ancestors
if (location == null)
{
List insertingComponentFragmentLocators =
ClassLoaderUtils.__getCachableServices(InsertingComponentFragmentLocator.class);
UIComponent currAncestor = component.getParent();
while (currAncestor != null)
{
if (currAncestor == viewRoot)
{
return _getPhysicalURI(viewRoot.getViewId());
}
// 2a. try to get the location where the tag for ancestor is defined
location = _getInsertedComponentLocation(context,
insertedComponentFragmentLocators,
currAncestor,
component);
if (location != null)
{
break;
}
else
{
// 2b. try to get the location of the fragment that the ancestor could have inserted
location = _getInsertingComponentLocation(context,
insertingComponentFragmentLocators,
currAncestor,
component);
if (location != null)
{
break;
}
}
currAncestor = currAncestor.getParent();
}
}
return location;
}
/**
* Gets the scoped identifier for the target component. The scoping will be
* within a subtree rooted by the supplied base component. If the supplied
* base component were to be the view root, the returned id will be the
* absolute id and hence prefixed with NamingContainer.SEPARATOR_CHARACTER.
*
* This algorithm reverse matches that of UIComponent.findComponent().
* In other words, the scoped id returned by this method can be safely used
* in calls to findComponent() on the baseComponent, if it were to be
* enclosing the targetComponent.
*
* This method assumes that the supplied baseComponent definitely encloses the
* targetComponent, return value is not reliable if this is not the case.
*
* Examples of id returned: ':foo:bar:baz'/'foo:baz'/'foo'
*
* @param targetComponent The component for which the scoped id needs to be
* determined.
* @param baseComponent The component relative to which the scoped id for the
* targetComponent needs to be determined.
* @return The scoped id for target component. Returns null if the supplied
* targetComponent was null or did not have an id.
*/
public static String getScopedIdForComponent(
UIComponent targetComponent,
UIComponent baseComponent)
{
return _getScopedIdForComponentImpl(targetComponent, baseComponent, false);
}
/**
* Gets the logical scoped identifier for the target component. The scoping will be
* within a subtree rooted by the supplied base component. The subtree will be computed in the
* context of the document or documents where the components were defined. If the supplied
* base component were to be the view root, the returned id will be the
* absolute id and hence prefixed with NamingContainer.SEPARATOR_CHARACTER.
*
* This algorithm reverse matches that of UIComponent.findComponent().
* In other words, the scoped id returned by this method can be safely used
* in calls to findComponent() on the baseComponent, if it were to be
* enclosing the targetComponent.
*
* This method assumes that the supplied baseComponent definitely encloses the
* targetComponent, return value is not reliable if this is not the case.
*
* Examples of id returned: ':foo:bar:baz'/'foo:baz'/'foo'
*
* @param targetComponent The component for which the scoped id needs to be
* determined.
* @param baseComponent The component relative to which the scoped id for the
* targetComponent needs to be determined.
* @return The scoped id for target component. Returns null if the supplied
* targetComponent was null or did not have an id.
*/
public static String getLogicalScopedIdForComponent(
UIComponent targetComponent,
UIComponent baseComponent)
{
return _getScopedIdForComponentImpl(targetComponent, baseComponent, true);
}
/**
* Provides the physical URI of the page with supplied logical view id. The implementation
* uses any registered page resolver to do the conversion.
*/
private static String _getPhysicalURI(String logicalViewId)
{
PageResolver pageResolver = RequestContext.getCurrentInstance().getPageResolver();
return pageResolver.getPhysicalURI(logicalViewId);
}
/**
* Returns scoped id for a component
* @param targetComponent The component for which the scoped id needs to be
* determined.
* @param baseComponent The component relative to which the scoped id for the
* targetComponent needs to be determined.
* @param isLogical true if a logical scoped id (the id in the context of the document where targetComponent was defined)
* should be returned, false otherwise
* @return The scoped id for target component. Returns null if the supplied
* targetComponent was null or did not have an id.
*/
private static String _getScopedIdForComponentImpl(
UIComponent targetComponent,
UIComponent baseComponent,
boolean isLogical)
{
String targetComponentId = targetComponent.getId();
if (targetComponent == null ||
targetComponentId == null ||
targetComponentId.length() == 0)
return null;
// Optimize when both arguments are the same
if (targetComponent.equals(baseComponent))
return targetComponentId;
StringBuilder builder = new StringBuilder(100);
// Add a leading ':' if the baseComponent is the view root
if (baseComponent instanceof UIViewRoot)
builder.append(NamingContainer.SEPARATOR_CHAR);
_buildScopedId(targetComponent, baseComponent, builder, isLogical);
return builder.toString();
}
/**
* Returns the nearest ancestor component, skipping over any
* flattening components.
*
* @param context the FacesContext
* @param component the UIComponent
* @return the first ancestor component that is not a FlattenedComponent
* that is actively flattening its children or null if no such ancestor
* component is found.
* @see org.apache.myfaces.trinidad.component.FlattenedComponent
*/
public static UIComponent getNonFlatteningAncestor(
FacesContext context,
UIComponent component)
{
UIComponent parent = component.getParent();
while (parent != null)
{
if (!_isFlattening(context, parent))
return parent;
parent = parent.getParent();
}
return null;
}
/**
* Iterates through all the registered InsertedComponentFragmentLocator services and gets
* the location of the fragment document where the tag corresponding to the supplied
* componentToTest is defined. Returns null if the location cannot be determined.
*/
private static String _getInsertedComponentLocation(
FacesContext context,
List insertedComponentFragmentLocators,
UIComponent componentToTest,
UIComponent targetComponent)
{
for (InsertedComponentFragmentLocator
insertedComponentFragmentLocator : insertedComponentFragmentLocators)
{
String location =
insertedComponentFragmentLocator.getFragmentUrlForInsertedComponent(context,
componentToTest,
targetComponent);
if (location != null)
{
return location;
}
}
return null;
}
/**
* Iterates through all the registered InsertingComponentFragmentLocator services and gets
* the location of the fragment document that the supplied componentToTest could have possibly
* inserted. Returns null if the location cannot be determined.
*/
private static String _getInsertingComponentLocation(
FacesContext context,
List insertingComponentFragmentLocators,
UIComponent componentToTest,
UIComponent targetComponent)
{
for (InsertingComponentFragmentLocator
insertingComponentFragmentLocator : insertingComponentFragmentLocators)
{
String location =
insertingComponentFragmentLocator.getInsertedFragmentUrl(context,
componentToTest,
targetComponent);
if (location != null)
{
return location;
}
}
return null;
}
private static boolean _isFlattening(FacesContext context, UIComponent component)
{
return ((component instanceof FlattenedComponent) &&
((FlattenedComponent)component).isFlatteningChildren(context));
}
/**
* Builds the scoped id. Adds the naming container's id and the separator char
* in a recursive fashion.
* @param targetComponent The component for which the scoped id needs to be
* built.
* @param baseComponent The component relative to which the scoped id for the
* targetComponent needs to be built.
* @param builder The StringBuilder which is to store the scoped id.
* @param isLogical true if the logical scoped id should be returned, false otherwise
* @return The String value of the scoped id
*/
private static void _buildScopedId(
UIComponent targetComponent,
UIComponent baseComponent,
StringBuilder builder,
boolean isLogical)
{
UIComponent namingContainer =
_getParentNamingContainer(targetComponent, baseComponent, isLogical);
if (namingContainer != null)
{
_buildScopedId(namingContainer, baseComponent, builder, isLogical);
builder.append(NamingContainer.SEPARATOR_CHAR);
}
builder.append(targetComponent.getId());
}
/**
* Returns the naming container of the component. This method makes sure that
* we don't go beyond the a supplied base component.
* @param component the UIComponent
* @param baseComponent The component to limit the search up to.
* @param isLogical true if logical parent hierarchy should be used, false otherwise
* @return the naming container of the component which has to be in the
* subtree rooted by the baseComponent. Returns null if no such ancestor
* naming container component exists.
*/
private static UIComponent _getParentNamingContainer(
UIComponent component,
UIComponent baseComponent,
boolean isLogical)
{
// Optimize when both arguments are the same - could happen due to recursion
// in _buildScopedId()
if (component.equals(baseComponent))
return null;
UIComponent checkedParent = component;
do
{
checkedParent = isLogical ? UIXComponent.getLogicalParent(checkedParent) : checkedParent.getParent();
if (checkedParent == null)
break;
if (checkedParent instanceof NamingContainer)
break;
// We hit the base component, abort.
if (checkedParent == baseComponent)
return null;
} while (true);
return checkedParent;
}
// given a component, get its naming container. If the component
// is a naming container, it will get its naming container.
// if no parent naming containers exist, it stops at the ViewRoot.
private static UIComponent _getParentNamingContainerOrViewRoot (
UIComponent from)
{
while (from.getParent() != null)
{
from = from.getParent();
if (from instanceof NamingContainer)
break;
}
return from;
}
/**
* Find a component relative to another.
* This method is the same as the 'old' public findRelativeComponent.
* This method is around so that the
* new findRelativeComponent method is backward compatibility.
*
* The relative ID must account for NamingContainers. If the component is already inside
* of a naming container, you can use a single colon to start the search from the root,
* or multiple colons to move up through the NamingContainers - "::" will search from
* the parent naming container, ":::" will search from the grandparent
* naming container, etc.
*
*
* @param from the component to search relative to
* @param relativeId the relative path to the component to find
* @return the component if found, null otherwise
*/
private static UIComponent _findRelativeComponentDeprecated(
UIComponent from,
String relativeId)
{
UIComponent originalFrom = from;
String originalRelativeId = relativeId;
int idLength = relativeId.length();
// Figure out how many colons
int colonCount = 0;
while (colonCount < idLength)
{
if (relativeId.charAt(colonCount) != NamingContainer.SEPARATOR_CHAR)
break;
colonCount++;
}
// colonCount == 0: fully relative
// colonCount == 1: absolute (still normal findComponent syntax)
// colonCount > 1: for each extra colon after 1, go up a naming container
// (to the view root, if naming containers run out)
if (colonCount > 1)
{
relativeId = relativeId.substring(colonCount);
for (int j = 1; j < colonCount; j++)
{
while (from.getParent() != null)
{
from = from.getParent();
if (from instanceof NamingContainer)
break;
}
}
}
UIComponent found = from.findComponent(relativeId);
if (found != null)
{
_LOG.warning("DEPRECATED_RELATIVE_ID_SYNTAX",
new Object[] {originalRelativeId, originalFrom});
}
return found;
}
static private final TrinidadLogger _LOG =
TrinidadLogger.createTrinidadLogger(ComponentUtils.class);
}