com.liferay.portal.odata.entity

Class EntityField

java.lang.Object

com.liferay.portal.odata.entity.EntityField

Direct Known Subclasses:

BooleanEntityField, CollectionEntityField, ComplexEntityField, DateEntityField, DateTimeEntityField, DoubleEntityField, IdEntityField, IntegerEntityField, StringEntityField

public class EntityField
extends java.lang.Object

Models an entity field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityField.Type

Constructor Summary

Constructors

Constructor and Description
EntityField(java.lang.String name, EntityField.Type type, java.util.function.Function<java.util.Locale,java.lang.String> filterableAndSortableFieldNameFunction) Deprecated. As of Judson (7.1.x)
EntityField(java.lang.String name, EntityField.Type type, java.util.function.Function<java.util.Locale,java.lang.String> sortableFieldNameFunction, java.util.function.Function<java.util.Locale,java.lang.String> filterableFieldNameFunction) Deprecated. As of Judson (7.1.x)
EntityField(java.lang.String name, EntityField.Type type, java.util.function.Function<java.util.Locale,java.lang.String> sortableFieldNameFunction, java.util.function.Function<java.util.Locale,java.lang.String> filterableFieldNameFunction, java.util.function.Function<java.lang.Object,java.lang.String> filterableFieldValueFunction) Creates a new EntityField with separate functions for converting the entity field's name to a sortable and filterable field name for a locale.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFilterableName(java.util.Locale locale) Returns the entity field's filterable name.
java.lang.String	getFilterableValue(java.lang.Object fieldValue) Returns the entity field's filterable value.
java.lang.String	getName() Returns the entity field's name.
java.lang.String	getSortableName(java.util.Locale locale) Returns the entity field's sortable name for a locale.
EntityField.Type	getType() Returns the entity field's type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityField

@Deprecated
public EntityField(java.lang.String name,
                               EntityField.Type type,
                               java.util.function.Function<java.util.Locale,java.lang.String> filterableAndSortableFieldNameFunction)

Deprecated. As of Judson (7.1.x)

Creates a new EntityField with a Function to convert the entity field's name to a filterable/sortable field name for a locale.

Parameters:

name - the entity field's name

type - the type

filterableAndSortableFieldNameFunction - the Function

EntityField

@Deprecated
public EntityField(java.lang.String name,
                               EntityField.Type type,
                               java.util.function.Function<java.util.Locale,java.lang.String> sortableFieldNameFunction,
                               java.util.function.Function<java.util.Locale,java.lang.String> filterableFieldNameFunction)

Deprecated. As of Judson (7.1.x)

Creates a new EntityField with a Function to convert the entity field's name to a filterable/sortable field name for a locale.

Parameters:

name - the entity field's name

type - the type

sortableFieldNameFunction - the sortable field name Function

filterableFieldNameFunction - the filterable field name Function

EntityField

public EntityField(java.lang.String name,
                   EntityField.Type type,
                   java.util.function.Function<java.util.Locale,java.lang.String> sortableFieldNameFunction,
                   java.util.function.Function<java.util.Locale,java.lang.String> filterableFieldNameFunction,
                   java.util.function.Function<java.lang.Object,java.lang.String> filterableFieldValueFunction)

Creates a new EntityField with separate functions for converting the entity field's name to a sortable and filterable field name for a locale.

Parameters:

name - the entity field's name

type - the type

sortableFieldNameFunction - the sortable field name Function

filterableFieldNameFunction - the filterable field name Function

filterableFieldValueFunction - the filterable field value Function

Method Detail

getFilterableName

public java.lang.String getFilterableName(java.util.Locale locale)

Returns the entity field's filterable name.

Parameters:

locale - the locale

Returns:

the filterable name

getFilterableValue

public java.lang.String getFilterableValue(java.lang.Object fieldValue)

Returns the entity field's filterable value.

Parameters:

fieldValue - the field value

Returns:

the filterable field value

getName

public java.lang.String getName()

Returns the entity field's name.

Returns:

the name

getSortableName

public java.lang.String getSortableName(java.util.Locale locale)

Returns the entity field's sortable name for a locale.

Parameters:

locale - the locale

Returns:

the sortable name

getType

public EntityField.Type getType()

Returns the entity field's type.

Returns:

the type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object