net.sf.jso.schema
Class FieldDescriptor

java.lang.Object
  net.sf.jso.schema.FieldDescriptor

All Implemented Interfaces:

java.io.Serializable

public class FieldDescriptor

extends java.lang.Object

implements java.io.Serializable

Class for storable field descritptors. Field descriptors represent fields of Storable implementations as they should be stored in JSO schema.

See Also:

Serialized Form

Constructor Summary

FieldDescriptor()
Constructs the field descriptor.

FieldDescriptor(java.lang.String aName, int aType, boolean isAccessible, boolean isSummary)
Constructs the field descriptor.

Method Summary

boolean	equals(java.lang.Object o) Indicates whether some other field descriptor is "equal to" this one.
java.lang.String	getName() Gets field's name.
int	getType() Gets field's type.
int	hashCode() Returns a hash code value for the field descriptor.
boolean	isAccessible() Indicates if the the field may be accessed by query engine.
boolean	isSummary() Indicates if this field is part of the class summary.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldDescriptor

public FieldDescriptor()

Constructs the field descriptor.

FieldDescriptor

public FieldDescriptor(java.lang.String aName,
                       int aType,
                       boolean isAccessible,
                       boolean isSummary)
                throws java.lang.IllegalArgumentException

Constructs the field descriptor.

Parameters:

aName - A name for the field.

aType - A type for the field.

isAccessible - Indicates if the query engine has access to this field.

isSummary - Indicates if this field is part of the class summary.

Method Detail

getName

public java.lang.String getName()

Gets field's name.

Returns:

Field's name.

getType

public int getType()

Gets field's type.

Returns:

Field's type.

isAccessible

public boolean isAccessible()

Indicates if the the field may be accessed by query engine.

Returns:

true if the field may be accessed by query engine; false otherwise.

isSummary

public boolean isSummary()

Indicates if this field is part of the class summary.

Returns:

true if the field is part of the summary; false otherwise.

equals

public boolean equals(java.lang.Object o)

Indicates whether some other field descriptor is "equal to" this one.

Parameters:

o - The object with which to compare.

Returns:

true if the field descriptor is the same as the field descriptor argument, or false otherwise.

hashCode

public int hashCode()

Returns a hash code value for the field descriptor.

Returns:

A hash code value for the field descriptor.