Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.wlevs.ede.api
Interface EventType

public interface EventType

This interface provides event type metadata for events.

The interface exposes events as organizations of named values. The contract is that any event in the system must have a name-based way of accessing sub-data within its event type. A simple example is a Java bean: the names can be property names, and those properties can have still more properties beneath them. Another example is a Map structure. Here string names can refer to data objects.

Information on the super-types (superclass and interfaces implemented by JavaBean events) is also available. Supertypes generally exclude Java language interfaces and types.

Method Summary
`EventBuilder.Factory` | `getEventBuilderFactory()` Returns EventBuilder.Factory which may be used to manufacture event objects of this event type.
`java.lang.String[]` | `getPropertyNames()` Get all valid property names for the event type.
`java.lang.Class` | `getPropertyType(java.lang.String property)` Get the type of an event property as returned by the "getter" method for that property.
`java.lang.Object` | `getPropertyValue(java.lang.Object underlying, java.lang.String property)` Retrieves property value from an event object of this event type.
`EventType[]` | `getSuperTypes()` Returns an array of event types that are super to this event type, from which this event type inherited event properties.
`java.lang.String` | `getTypeName()` Returns the registered event type name associated with this EventType.
`java.lang.Class` | `getUnderlyingType()` Get the class that represents the Java type of the event type.
`boolean` | `isProperty(java.lang.String property)` Check that the given property name is valid for this event type, ie. that is exists in the event type.

Method Detail

### getPropertyType

    public java.lang.Class getPropertyType(java.lang.String property)

  Get the type of an event property as returned by the "getter" method for that property. Returns unboxed (such as 'int.class') as well as boxed (java.lang.Integer) type. Returns null if the property name is not valid.

  Parameters:
    `property` - is the property name
  Returns:
    type of the property, the unboxed or the boxed type.

### getUnderlyingType

    public java.lang.Class getUnderlyingType()

  Get the class that represents the Java type of the event type. Returns a Java bean event class if the schema represents a Java bean event type. Returns java.util.Map if the schema represents a collection of values in a Map.

  Returns:
    type of the event object

### getPropertyNames

    public java.lang.String[] getPropertyNames()

  Get all valid property names for the event type.

  Returns:
    A string array containing the property names of this typed event data object.

### isProperty

    public boolean isProperty(java.lang.String property)

  Check that the given property name is valid for this event type, ie. that is exists in the event type.

  Parameters:
    `property` - is the property to check
  Returns:
    true if exists, false if not

### getSuperTypes

    public EventType[] getSuperTypes()

  Returns an array of event types that are super to this event type, from which this event type inherited event properties.

  For Java bean instances underlying the event this method returns the event types for all superclasses extended by the Java bean and all interfaces implemented by the Java bean.

  Returns:
    an array of event types

### getTypeName

    public java.lang.String getTypeName()

  Returns the registered event type name associated with this EventType.

  Returns:
    event type name

### getPropertyValue

    public java.lang.Object getPropertyValue(java.lang.Object underlying,
                                             java.lang.String property)

  Retrieves property value from an event object of this event type.

  Parameters:
    `underlying` - event object from which to retrieve value
    `property` - property name whose value is to be retrieved
  Returns:
    value of property for underlying event object

### getEventBuilderFactory

    public EventBuilder.Factory getEventBuilderFactory()

  Returns EventBuilder.Factory which may be used to manufacture event objects of this event type.

  Returns:
    factory to manufacture events of this type

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2007 BEA Systems All Rights Reserved.