com.sap.cloud.server.odata

Class SelectItem

java.lang.Object

com.sap.cloud.server.odata.SelectItem

public class SelectItem
extends java.lang.Object

Encapsulates an OData select item. A select item indicates a property (or expression) that is used in the $select system query option.

See Also:

DataQuery.selectItems.

Constructor Summary

Constructors

Constructor and Description
SelectItem()

Method Summary

Modifier and Type	Method and Description
DataPath	getPath() Return a path to be expanded in the query results.
boolean	isHidden() Return was this select item added for internal use (e.g.
static SelectItem	of(PropertyPath item) Return a new select item for the specified property.
void	setHidden(boolean value) Set was this select item added for internal use (e.g.
void	setPath(DataPath value) Set a path to be expanded in the query results.
Property	toProperty() If this select item references a simple property path, then return the property.
Property	toRequiredProperty() If this select item references a simple property path, then return the property.
java.lang.String	toString() Return a string representation of this select item.

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectItem

public SelectItem()

Method Detail

getPath

public DataPath getPath()

Return a path to be expanded in the query results.

Returns:

A path to be expanded in the query results.

isHidden

public boolean isHidden()

Return was this select item added for internal use (e.g. needed for server-side query processing, but not requested by client).

Returns:

Was this select item added for internal use

of

public static SelectItem of(PropertyPath item)

Return a new select item for the specified property.

Parameters:

item - Item to be selected.

Returns:

A new select item for the specified property.

setHidden

public void setHidden(boolean value)

Set was this select item added for internal use (e.g. needed for server-side query processing, but not requested by client).

Parameters:

value - Was this select item added for internal use

setPath

public void setPath(DataPath value)

Set a path to be expanded in the query results.

Parameters:

value - A path to be expanded in the query results.

toProperty

public Property toProperty()

If this select item references a simple property path, then return the property. Otherwise return null.

Returns:

(nullable) The property to be selected, or null.

toRequiredProperty

public Property toRequiredProperty()

If this select item references a simple property path, then return the property. Otherwise throw an exception.

Throws:

UndefinedException if this select item does not reference a simple property path.

Returns:

The property to be selected.

toString

public java.lang.String toString()

Return a string representation of this select item.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this select item.