com.jrockit.mc.flightrecorder.spi
Interface IField

All Known Implementing Classes:

ConstantField, DurationField, EndTimeField, EventTypeField, EventTypePathField, Field, ProducerField, ProducerURIField, ReferenceField, StartTimeField

public interface IField

Interface for describing and accessing an event value.

Author:

Erik Gahlin

Method Summary

java.lang.String	getContentType() Returns the content type
java.lang.String	getDescription() Return a description of the field.
java.lang.String	getEventTypePath() Returns the event type path for the event type.
java.lang.String	getIdentifier() Returns the identifier for the field.
java.lang.String	getName() Returns a human readable name of the field.
java.util.Set<java.lang.String>	getPropertyKeys() Returns the property keys available for the field.
java.lang.Object	getPropertyValue(java.lang.String key) Returns the property value for the field.
java.lang.String	getRelationalKey() Return the relation key for the field, or null if not available.
FieldType	getType() Returns the type of the field.
java.lang.Object	getValue(IEvent event) Returns a field value for an event
boolean	isRelational() Returns true If the field has a relational key.
boolean	isSynthetic() Returns true if the field is synthetic.
boolean	isVisible() Return true if the field should be visible.

Method Detail

getPropertyKeys

java.util.Set<java.lang.String> getPropertyKeys()

Returns the property keys available for the field.

Returns:

the property keys for the field

getPropertyValue

java.lang.Object getPropertyValue(java.lang.String key)

Returns the property value for the field.

Parameters:

key -

Returns:

the value associated with key, or null if not available.

getName

java.lang.String getName()

Returns a human readable name of the field.

Returns:

the name

getDescription

java.lang.String getDescription()

Return a description of the field.

Returns:

the description.

getValue

java.lang.Object getValue(IEvent event)

Returns a field value for an event

Parameters:

event - the event

Returns:

value the value

getIdentifier

java.lang.String getIdentifier()

Returns the identifier for the field.

Returns:

the identifier for the field

getContentType

java.lang.String getContentType()

Returns the content type

Returns:

the content type

getEventTypePath

java.lang.String getEventTypePath()

Returns the event type path for the event type.

Returns:

the event type path

isVisible

boolean isVisible()

Return true if the field should be visible.

Returns:

true if visible, false otherwise

isRelational

boolean isRelational()

Returns true If the field has a relational key.

Returns:

true if the field is relational, false otherwise

isSynthetic

boolean isSynthetic()

Returns true if the field is synthetic.

Returns:

true if the field is synthetic

getRelationalKey

java.lang.String getRelationalKey()

Return the relation key for the field, or null if not available.

Returns:

the relational key for the field.

getType

FieldType getType()

Returns the type of the field. See FieldType for more information.

Returns:

the type

See Also:

FieldType