org.julp

Interface MetaData<T>

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractMetaData, DBMetaData

public interface MetaData<T>
extends java.io.Serializable

Implement methods as needed

Method Summary

Modifier and Type	Method and Description
java.lang.Class<T>	getDomainClass()
java.lang.Class<?>	getFieldClass(int fieldIndex)
java.lang.String	getFieldClassName(int fieldIndex)
int	getFieldCount()
int	getFieldIndexByFieldName(java.lang.String searchedFieldName)
java.lang.String	getFieldLabel(int fieldIndex)
java.lang.String	getFieldName(int fieldIndex)
java.util.Map<java.lang.String,java.lang.String>	getMapping()
int	getPrecision(int fieldIndex) Get the designated field's number of decimal digits.
java.lang.reflect.Method	getReadMethod(int fieldIndex)
int	getScale(int fieldIndex) Gets the designated field's number of digits to right of the decimal point.
java.lang.reflect.Method	getWriteMethod(int fieldIndex)
boolean	isCaseSensitive(int fieldIndex) Indicates whether a field's case matters.
boolean	isCurrency(int fieldIndex) Indicates whether the designated field is a cash value.
boolean	isDefinitelyWritable(int fieldIndex) Indicates whether a write on the designated field will definitely succeed.
int	isNullable(int fieldIndex) Indicates the nullability of values in the designated field.
boolean	isPopulated()
boolean	isReadOnly(int fieldIndex) Indicates whether the designated field is definitely not writable.
boolean	isSearchable(int fieldIndex) Indicates whether the designated field can be used in a where clause.
boolean	isSigned(int fieldIndex) Indicates whether values in the designated field are signed numbers.
boolean	isThrowMissingFieldException()
boolean	isWritable(int fieldIndex) Indicates whether it is possible for a write on the designated field to succeed.
void	populate(java.util.Map<java.lang.String,java.lang.String> mapping, java.lang.Class domainClass)
void	setCaseSensitive(int fieldIndex, boolean property) Sets whether the designated field is case sensitive.
void	setCurrency(int fieldIndex, boolean property) Sets whether the designated field is a cash value.
void	setDefinitelyWritable(int fieldIndex, boolean definitelyWritable)
void	setFieldClass(int fieldIndex, java.lang.Class<?> fieldClass)
void	setFieldClassName(int fieldIndex, java.lang.String fieldClassName)
void	setFieldCount(int fieldCount)
void	setFieldLabel(int fieldIndex, java.lang.String fieldLabel)
void	setFieldName(int fieldIndex, java.lang.String fieldName)
void	setNullable(int fieldIndex, int property) Sets whether the designated field's value can be set to NULL.
void	setPrecision(int fieldIndex, int precision) Sets the designated field's number of decimal digits to the given int.
void	setReadMethod(int fieldIndex, java.lang.reflect.Method readMethod)
void	setReadOnly(int fieldIndex, boolean readOnly)
void	setScale(int fieldIndex, int scale) Sets the designated field's number of digits to the right of the decimal point to the given int.
void	setSearchable(int fieldIndex, boolean property) Sets whether the designated field can be used in a where clause.
void	setSigned(int fieldIndex, boolean property) Sets whether the designated field is a signed number.
void	setThrowMissingFieldException(boolean throwMissingFieldException)
void	setWritable(int fieldIndex, boolean writable)
void	setWriteMethod(int fieldIndex, java.lang.reflect.Method writeMethod)
java.lang.String	toLabel(java.lang.String fieldName)

Method Detail

getDomainClass

java.lang.Class<T> getDomainClass()

getFieldClass

java.lang.Class<?> getFieldClass(int fieldIndex)

getFieldClassName

java.lang.String getFieldClassName(int fieldIndex)
                            throws DataAccessException

Throws:

DataAccessException

getFieldCount

int getFieldCount()

getFieldIndexByFieldName

int getFieldIndexByFieldName(java.lang.String searchedFieldName)

getFieldLabel

java.lang.String getFieldLabel(int fieldIndex)
                        throws DataAccessException

Throws:

DataAccessException

getFieldName

java.lang.String getFieldName(int fieldIndex)
                       throws DataAccessException

Throws:

DataAccessException

getMapping

java.util.Map<java.lang.String,java.lang.String> getMapping()

isPopulated

boolean isPopulated()

getPrecision

int getPrecision(int fieldIndex)
          throws DataAccessException

Get the designated field's number of decimal digits.

Returns:

precision

Throws:

DataAccessException - if an error occurs

getReadMethod

java.lang.reflect.Method getReadMethod(int fieldIndex)
                                throws DataAccessException

Throws:

DataAccessException

getScale

int getScale(int fieldIndex)
      throws DataAccessException

Gets the designated field's number of digits to right of the decimal point.

Returns:

scale

Throws:

DataAccessException - if an error occurs

getWriteMethod

java.lang.reflect.Method getWriteMethod(int fieldIndex)
                                 throws DataAccessException

Throws:

DataAccessException

isCaseSensitive

boolean isCaseSensitive(int fieldIndex)
                 throws DataAccessException

Indicates whether a field's case matters.

Returns:

true if so; false otherwise

Throws:

DataAccessException - if an error occurs

isCurrency

boolean isCurrency(int fieldIndex)
            throws DataAccessException

Indicates whether the designated field is a cash value.

Returns:

true if so; false otherwise

Throws:

DataAccessException - if an error occurs

isDefinitelyWritable

boolean isDefinitelyWritable(int fieldIndex)
                      throws DataAccessException

Indicates whether a write on the designated field will definitely succeed.

Returns:

true if so; false otherwise

Throws:

DataAccessException - if an error occurs

isNullable

int isNullable(int fieldIndex)
        throws DataAccessException

Indicates the nullability of values in the designated field.

Returns:

the nullability status of the given field; one of fieldNoNulls, fieldNullable or fieldNullableUnknown

Throws:

DataAccessException - if an error occurs

isReadOnly

boolean isReadOnly(int fieldIndex)
            throws DataAccessException

Indicates whether the designated field is definitely not writable.

Returns:

true if so; false otherwise

Throws:

DataAccessException - if an error occurs

isSearchable

boolean isSearchable(int fieldIndex)
              throws DataAccessException

Indicates whether the designated field can be used in a where clause.

Returns:

true if so; false otherwise

Throws:

DataAccessException - if an error occurs

isSigned

boolean isSigned(int fieldIndex)
          throws DataAccessException

Indicates whether values in the designated field are signed numbers.

Returns:

true if so; false otherwise

Throws:

DataAccessException - if an error occurs

isThrowMissingFieldException

boolean isThrowMissingFieldException()

isWritable

boolean isWritable(int fieldIndex)
            throws DataAccessException

Indicates whether it is possible for a write on the designated field to succeed.

Returns:

true if so; false otherwise

Throws:

DataAccessException - if an error occurs

populate

void populate(java.util.Map<java.lang.String,java.lang.String> mapping,
              java.lang.Class domainClass)
       throws DataAccessException

Throws:

DataAccessException

setCaseSensitive

void setCaseSensitive(int fieldIndex,
                      boolean property)
               throws DataAccessException

Sets whether the designated field is case sensitive. The default is false.

Parameters:

property - true if the field is case sensitive; false if it is not

Throws:

DataAccessException - if an error occurs

setCurrency

void setCurrency(int fieldIndex,
                 boolean property)
          throws DataAccessException

Sets whether the designated field is a cash value. The default is false.

Parameters:

property - true if the field is a cash value; false if it is not

Throws:

DataAccessException - if an error occurs

setDefinitelyWritable

void setDefinitelyWritable(int fieldIndex,
                           boolean definitelyWritable)

setFieldClass

void setFieldClass(int fieldIndex,
                   java.lang.Class<?> fieldClass)

setFieldClassName

void setFieldClassName(int fieldIndex,
                       java.lang.String fieldClassName)
                throws DataAccessException

Throws:

DataAccessException

setFieldCount

void setFieldCount(int fieldCount)

setFieldLabel

void setFieldLabel(int fieldIndex,
                   java.lang.String fieldLabel)
            throws DataAccessException

Throws:

DataAccessException

setFieldName

void setFieldName(int fieldIndex,
                  java.lang.String fieldName)
           throws DataAccessException

Throws:

DataAccessException

setNullable

void setNullable(int fieldIndex,
                 int property)
          throws DataAccessException

Sets whether the designated field's value can be set to NULL. The default is ResultSetMetaData.fieldNullableUnknown

Parameters:

property - one of the following constants: ResultSetMetaData.fieldNoNulls, ResultSetMetaData.fieldNullable, or ResultSetMetaData.fieldNullableUnknown

Throws:

DataAccessException - if an error occurs

setPrecision

void setPrecision(int fieldIndex,
                  int precision)
           throws DataAccessException

Sets the designated field's number of decimal digits to the given int.

Parameters:

precision - the total number of decimal digits

Throws:

DataAccessException - if an error occurs

setReadMethod

void setReadMethod(int fieldIndex,
                   java.lang.reflect.Method readMethod)

setReadOnly

void setReadOnly(int fieldIndex,
                 boolean readOnly)
          throws DataAccessException

Throws:

DataAccessException

setScale

void setScale(int fieldIndex,
              int scale)
       throws DataAccessException

Sets the designated field's number of digits to the right of the decimal point to the given int.

Parameters:

scale - the number of digits to right of decimal point

Throws:

DataAccessException - if an error occurs

setSearchable

void setSearchable(int fieldIndex,
                   boolean property)
            throws DataAccessException

Sets whether the designated field can be used in a where clause. The default is false.

Parameters:

property - true if the field can be used in a WHERE clause; false if it cannot

Throws:

DataAccessException - if an error occurs

setSigned

void setSigned(int fieldIndex,
               boolean property)
        throws DataAccessException

Sets whether the designated field is a signed number. The default is false.

Parameters:

property - true if the field is a signed number; false if it is not

Throws:

DataAccessException - if an error occurs

setThrowMissingFieldException

void setThrowMissingFieldException(boolean throwMissingFieldException)

setWritable

void setWritable(int fieldIndex,
                 boolean writable)

setWriteMethod

void setWriteMethod(int fieldIndex,
                    java.lang.reflect.Method writeMethod)

toLabel

java.lang.String toLabel(java.lang.String fieldName)