Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


oracle.adf.view.rich.model
Class AttributeDescriptor

java.lang.Object
  extended by oracle.adf.view.rich.model.AttributeDescriptor

Direct Known Subclasses:
ColumnDescriptor

public abstract class AttributeDescriptor
extends java.lang.Object

An AttributeDescriptor represents an attribute that is part of a view object (in ADF) or any other model object.


Nested Class Summary
static class AttributeDescriptor.ComponentType
          List of component types.
 class AttributeDescriptor.Operator
          Represents an operator supported by an attribute.

 

Constructor Summary
AttributeDescriptor()
           

 

Method Summary
abstract  AttributeDescriptor.ComponentType getComponentType()
          Returns the component to use to render the value part of the search field.
 javax.faces.convert.Converter getConverter()
          Returns a converter instance to use with this Attribute.
abstract  java.lang.String getDescription()
          Returns the description for the attribute.
 java.lang.String getFormat()
          Returns a format to use when showing a locale specific value for this attribute.
abstract  java.lang.String getLabel()
          Returns the label or the display name for the attribute.
abstract  int getLength()
          Returns the size of the text control specified by the number of characters shown.
abstract  int getMaximumLength()
          Returns the the maximum number of characters per line that can be entered into the text control.
abstract  java.lang.Object getModel()
          Returns the model object that represents the data for the component.
abstract  java.lang.String getName()
          Returns the name of the attribute.
abstract  java.util.Set<AttributeDescriptor.Operator> getSupportedOperators()
          Returns a Set of operators to use for the current attribute.
abstract  java.lang.Class getType()
          Returns the data type of the attribute.
 boolean hasDefaultConverter()
          Returns a boolean to specify whether there is a default converter based on the data type This default converter will be created and attached to the component.
 boolean isIndexed()
          Indicates whether the attribute is part of an index in the data model.
abstract  boolean isReadOnly()
          Whether the attribute is readOnly.
abstract  boolean isRequired()
          Whether the attribute is required or not.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

AttributeDescriptor

public AttributeDescriptor()

Method Detail

getComponentType

public abstract AttributeDescriptor.ComponentType getComponentType()
Returns the component to use to render the value part of the search field. When the attribute has no component type associated with it, then the component to use is determined by its type.
Returns:
a ComponentType enum.

getDescription

public abstract java.lang.String getDescription()
Returns the description for the attribute. This can be used to provide extra information about the attribute. Used in tooltips.

getFormat

public java.lang.String getFormat()
Returns a format to use when showing a locale specific value for this attribute.
For e.g., this could be a pattern like mm/dd/yyyy to use when converting the value. The format pattern used depends on the dataType of the attribute.
Returns:
an Object.

getConverter

public javax.faces.convert.Converter getConverter()
Returns a converter instance to use with this Attribute.
Returns:
an Converter Object.

getLabel

public abstract java.lang.String getLabel()
Returns the label or the display name for the attribute. The label is may be used as the prompt for a field (in a form layout), or for a header text (in a table layout).
Returns:
a String

getLength

public abstract int getLength()
Returns the size of the text control specified by the number of characters shown. The length is estimated based on the default font size of the browser.

getMaximumLength

public abstract int getMaximumLength()
Returns the the maximum number of characters per line that can be entered into the text control. This includes the characters representing the new line. If set to 0 or less, the maximumLength is ignored.

getModel

public abstract java.lang.Object getModel()
Returns the model object that represents the data for the component.

getName

public abstract java.lang.String getName()
Returns the name of the attribute. This differs from getLabel() in that, the name is purely a programmatic name, not a user-displayed name.

getSupportedOperators

public abstract java.util.Set<AttributeDescriptor.Operator> getSupportedOperators()
Returns a Set of operators to use for the current attribute. This is particularly used when performing a QBE based on a value entered by user.
Returns:
a Set<Operator<

getType

public abstract java.lang.Class getType()
Returns the data type of the attribute. It is used to determine the type of component and the converter to use when rendering its value.
Returns:
a valid java.lang.Class instance

isReadOnly

public abstract boolean isReadOnly()
Whether the attribute is readOnly. A true value indicates that a value cannot be entered for this attribute.
Returns:
a boolean.

isRequired

public abstract boolean isRequired()
Whether the attribute is required or not.
Returns:
a boolean false.

isIndexed

public boolean isIndexed()
Indicates whether the attribute is part of an index in the data model. This information may be used to render a special indicator.
Returns:
a boolean true/false value. The default implementation returns false.

hasDefaultConverter

public boolean hasDefaultConverter()
Returns a boolean to specify whether there is a default converter based on the data type This default converter will be created and attached to the component. If the getConverter() method however returns a converter, it will be attached to the component irrespective of this API.
Returns:
a boolean

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.