Package org.apache.juneau.commons.beanquery

Class QueryProperty

java.lang.Object

org.apache.juneau.commons.beanquery.QueryProperty

public final class QueryProperty
extends Object

One bean property as BeanQuery sees it: its column name, value type and inferred SearchType, and how to read and write it.

Instances come from QueryModel. The name is the Juneau bean property name, after @BeanProp and the configured PropertyNamer, so it is the name serializers emit. Reads use the getter (or record accessor), else the field. Writes use the setter, else a non-final field.

Example:

QueryProperty age = QueryModel.of(Person.class).getReadableProperty("age"); SearchType type = age.getSearchType(); // NUMERIC Object value = age.read(person);

Since:

10.0.0

Method Summary

Modifier and Type	Method	Description
boolean	canRead()	Returns true if the property has a getter or a field and isn't write-only.
boolean	canWrite()	Returns true if the property has a setter or a non-final field.
String	getName()	Returns the property (column) name.
SearchType	getSearchType()	Returns the search type inferred from getType().
Class<?>	getType()	Returns the declared read type: the getter's return type, else the field type, else the setter's parameter type.
Class<?>	getWriteType()	Returns the type write(Object, Object) accepts: the setter's parameter type, else getType().
Object	read(Object bean)	Reads the property from a bean.
static SearchType	searchTypeOf(Class<?> t)	Infers a column's SearchType from a property's declared type.
String	toString()
void	write(Object bean, Object value)	Writes the property on a bean.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

searchTypeOf

public static SearchType searchTypeOf(Class<?> t)

Infers a column's SearchType from a property's declared type.

Booleans are SearchType.BOOLEAN; characters are SearchType.TEXT; primitives and Numbers are SearchType.NUMERIC; enums are SearchType.ENUM; dates, calendars and temporals are SearchType.TIMESTAMP; everything else is SearchType.TEXT.

Example:

QueryProperty.searchTypeOf(int.class); // NUMERIC QueryProperty.searchTypeOf(Instant.class); // TIMESTAMP QueryProperty.searchTypeOf(String.class); // TEXT

Parameters:

t - The property type. Must not be null.

Returns:

The inferred type (never null).

getName

public String getName()

Returns the property (column) name.

Returns:

The name. Never null.

getType

public Class<?> getType()

Returns the declared read type: the getter's return type, else the field type, else the setter's parameter type.

Returns:

The type. Never null.

getWriteType

public Class<?> getWriteType()

Returns the type write(Object, Object) accepts: the setter's parameter type, else getType().

Returns:

The type. Never null.

getSearchType

public SearchType getSearchType()

Returns the search type inferred from getType().

Returns:

The search type. Never null.

canRead

public boolean canRead()

Returns true if the property has a getter or a field and isn't write-only.

Returns:

true if read(Object) is supported.

canWrite

public boolean canWrite()

Returns true if the property has a setter or a non-final field.

@BeanProp(ro) is deliberately ignored: in Juneau it means "parsers must not set this property", and loading a database row is not parsing.

Returns:

true if write(Object, Object) is supported.

read

public Object read(Object bean)

Reads the property from a bean.

Parameters:

bean - The bean. Must not be null.

Returns:

The value. Can be null.

Throws:

BeanQueryExecutionException - If the getter throws or the value can't be read. The cause is the getter's own exception.

IllegalArgumentException - If bean is null.

IllegalStateException - If the property is not readable.

write

public void write(Object bean,
 Object value)

Writes the property on a bean. A null for a primitive property is ignored, so the bean keeps its default.

Parameters:

bean - The bean. Must not be null.

value - The value, assignable to getWriteType(). Can be null.

Throws:

BeanQueryExecutionException - If the setter throws or the value can't be written. The cause is the setter's own exception.

IllegalArgumentException - If bean is null.

IllegalStateException - If the property is not writable.

toString

public String toString()

Overrides:

toString in class Object