All Classes and Interfaces
Class
Description
OData entity.
Abstract representation of an OData entity property value.
AbstractEntityCollectionInvocationHandler<T extends EntityType<?>,EC extends EntityCollection<T,?,?>>
Interface for synchronous CRUD operations on an EntitySet.
Abstract OData object with basic values (
id, baseURI, title).Entry point for proxy mode, gives access to entity container instances.
AbstractSingleton<T extends EntityType<?>,KEY extends Serializable,EC extends EntityCollection<T,?,?>>
Internally used
AcceptType for OData library.Processor interface for handling an action request with a return type of ComplexCollection.
Processor interface for handling an action request with a return type of Complex.
Processor interface for handling an action request with a return type of Entity Collection.
Processor interface for handling an action request with a return type of Entity.
Processor interface for handling an action request with a return type of Primitive Collection.
Processor interface for handling an action request with a return type of Primitive.
Processor interface for handling an action request with no return type.
Represents the aggregate transformation.
Represents an aggregate expression.
Standard aggregation method.
Represents an alias expression node in the expression tree
A alias expression node is inserted in the expression tree for any valid alias
E.g.
A alias expression node is inserted in the expression tree for any valid alias
E.g.
Represents an alias value defined as query option
For example:
http://.../?
An element with instance annotations.
Represents an instance annotation.
Represents a single transformation from the system query option $apply.
The kind of the transformation.
Represents the system query option $apply, defined in the data aggregation extension.
Provides methods to process
ODataRequests and BatchRequestParts
in the context of a batch request.Batch request payload management.
Options for the batch deserializer.
BatchOptions builder
Processor interface for handling a single instance of an Entity Type.
Represents a distinct MIME part of a Batch Request body - either a Change Set or a Query Operation
Thrown for invalid batch payloads.
Represents a binary expression node in the expression tree
A binary expression node is inserted in the expression tree for any valid ODATA binary operator in
A binary expression node is inserted in the expression tree for any valid ODATA binary operator in
BinaryOperatorKind.Enumeration of supported binary operators
For the semantic of these operators please see the ODATA specification for URL conventions
For the semantic of these operators please see the ODATA specification for URL conventions
Represents a transformation with one of the pre-defined methods
bottomcount, bottompercent, bottomsum,
topcount, toppercent, topsum.Pre-defined method for partial aggregration.
OData collection property value.
OData complex property value.
OData entity.
OData entity collection.
OData entity set iterator class.
OData in-line entity.
OData in-line entity set.
Marker interface for any OData domain object that can be returned by an operation invocation.
Abstract representation of OData entities and links.
OData link.
OData link types.
Marker class for invoke with no return type.
Entry point for generating OData domain objects.
OData entity property.
Abstract representation of an OData entity property value.
Associate EntityType Java object with its collection.
ComplexCollection<T extends StructuredType<?>,EC extends Collection<T>,CT extends StructuredCollection<T,EC,?>>
Processor interface for handling a collection of complex-type instances, e.g.,
a property of an entity defined as collection of complex-type instances.
Processor interface for handling an instance of a complex type, e.g., a complex property of an entity.
Options for the OData serializer.
Builder of OData serializer options.
Mark POJO as EDM complex type.
Represents the value of a complex property.
Abstract base class for all Geometries that are composed out of other geospatial elements.
Identifies a compound key.
Mark multi key class field (property) as multi key element.
Represents the compute transformation.
Represents a compute expression.
Represents the concat transformation.
Configuration wrapper.
Constant values related to the OData protocol.
Constant values related to the OData protocol.
Constant values related to the OData protocol.
Internally used
ContentType for OData library.High-level representation of a context URL, built from the string value returned by a service; provides access to the
various components of the context URL, defined in the
protocol specification.
Builder for a ContextURL instance.
Suffix of the OData Context URL
Processor interface for handling counting a collection of complex properties, e.g. an EdmComplexType.
Processor interface for handling counting a collection of entities, e.g. an Entity Set.
Represents the system query option $count
For example:
http://...
Processor interface for handling counting a collection of primitive properties, e.g. an collection of EdmString.
Super type of all CsdlEdmItems
Dummy implementation of
CsdlEdmProviderRepresents an action CSDL item
Represents an action import CSDL item
Represents an alias info CSDL item
Super type of all annotatable CSDL items
Represents a CSDL annotation
Represents an annotation path
The type Csdl annotations.
The type Csdl binding target.
Represents an edm:Cast expression.
The edm:Collection expression enables a value to be obtained from zero or more child expressions.
The type Csdl complex type.
Type of the constant expression
The interface Csdl edm provider.
The type Csdl entity container.
The type Csdl entity container info.
The type Csdl entity set.
The type Csdl entity set path.
The type Csdl entity type.
The type Csdl enum member.
The type Csdl enum type.
The type Csdl function.
The type Csdl function import.
Represents a edm:If expression
The edm:IsOf expression evaluates a child expression and returns a Boolean value indicating whether
the child expression returns the specified type
The edm:LabeledElement expression assigns a name to a child expression.
The edm:LabeledElementReference expression returns the value of an
edm:LabeledElement (see
CsdlLabeledElement) expression.Type of the constant expression
Content of this class does not appear within the CSDL metadata document.
The interface Csdl named.
The type Csdl navigation property.
The type Csdl navigation property binding.
The edm:NavigationPropertyPath expression provides a value for terms or term properties that specify the
built-in abstract type Edm.NavigationPropertyPath
The edm:Null expression returns an untyped null value.
The type Csdl on delete.
The enum Csdl on delete action.
The type Csdl operation.
The type Csdl operation import.
The type Csdl parameter.
The edm:Path expression enables a value to be obtained by traversing an object graph.
The type Csdl property.
The edm:PropertyPath expression provides a value for terms or term properties that specify the built-in
abstract type Edm.PropertyPath.
The type Csdl property ref.
The edm:PropertyValue element supplies a value to a property on the type instantiated by an
edm:Record expression (See
EdmRecord).The edm:Record expression enables a new entity type or complex type instance to be constructed.
The type Csdl referential constraint.
The type Csdl return type.
The type Csdl schema.
The type Csdl singleton.
The type Csdl structural type.
The type Csdl term.
The type Csdl type definition.
The edm:UrlRef expression enables a value to be obtained by sending a GET request to the value of
the UrlRef expression.
Processors that supports custom content types can implement this interface.
Processors that would like to support etags for certain entity sets can implement this
interface.
Represents a transformation with a custom function.
Represents a custom query option
For example:
http://...
This class contains all information necessary to construct a debug response.
Support for applications creating debug responses.
Register this interface to add debug support to your service.
Supports the default debug case.
Processor implementation for handling default cases:
request for the metadata document
request for the service document
error handling
A deleted entity contains the reason for deletion and the id.
Reason of the removal from the list
A Delta instance contains all added and deleted links and all deleted entities.
A delta link.
Processor interface for handling a single instance of an Delta Response.
Exception thrown by deserializers.
Keys for exception texts in the resource bundle.
Result type for
ODataDeserializer methodsEntity Data Model (EDM)
Interface representing a Entity Data Model as described in the Conceptual Schema Definition.
Interface representing a Entity Data Model as described in the Conceptual Schema Definition.
A CSDL action.
An EdmActionImport element.
Objects of this class contain information about one action import inside the EntityDataModel.
Represents a logical and annotation
Can be applied to CSDL elements as described in the Conceptual Schema Definition Language.
This class models an OData Annotation which can be applied to a target.
Represents an annotation path
This is used to apply a group of annotations to a single model element.
Represents an Edm:Apply expression
EDM-assisted serializer
Options for the EDM-assisted serializer.
Builder of serializer options.
Entity Sets or Singletons can be bound to each other using a navigation property binding so an
EdmBindingTarget can either be an EdmEntitySet or an EdmSingleton.Represents an edm:Cast expression.
The edm:Collection expression enables a value to be obtained from zero or more child expressions.
A CSDL ComplexType element.
Represents a constant expression
Represents a dynamic expression
A CSDL EntityContainer element.
A CSDL EntitySet element.
A CSDL EntityType element.
An EdmEnumType represents a set of related values.
Represents a edm:Eq expression
Super type of all annotation expressions
A expression is either constant or dynamic
An EdmFunction as described in the OData specification
A CSDL FunctionImport element
Represents a edm:Ge expression
Represents a edm:Gt expression
Represents a edm:If expression
The edm:IsOf expression evaluates a child expression and returns a Boolean value indicating whether
the child expression returns the specified type
A key property reference element.
The edm:LabeledElement expression assigns a name to a child expression.
The edm:LabeledElementReference expression returns the value of an
edm:LabeledElement (see
EdmLabeledElement) expression.Represents a edm:Le expression
Represents a generic expression with two child exprssions
Represents a edm:Lt expression
EdmMappable can be applied to CSDL elements to associate additional information.
EdmMapping holds custom mapping information which can be applied to a CSDL element.
An
EdmEnumType member element.This class implements a metadata query request.
EdmNamed is the base interface for nearly all CSDL constructs.
A CSDL NavigationProperty element
EdmNavigationProperty allows navigation from one entity type to another via a relationship.
EdmNavigationProperty allows navigation from one entity type to another via a relationship.
A navigation property binding which binds entity sets or singletons with each other.
The edm:NavigationPropertyPath expression provides a value for terms or term properties that specify the
built-in abstract type Edm.NavigationPropertyPath
Represents a edm:Ne expression
Represents a logical edm:Le expression
The edm:Null expression returns an untyped null value.
A navigation property MAY define one edm:OnDelete element.
A EdmOperation can either be an
EdmAction or an EdmFunction.An EdmOperationImport can be an EdmActionImport or an EdmFunctionImport.
Objects of this class contain information about one action or function import inside the EntityDataModel.
Represents a logical edm:And expression
A CSDL parameter element
The edm:Path expression enables a value to be obtained by traversing an object graph.
EdmPrimitiveType is a primitive type as defined in the Entity Data Model (EDM).
Enumeration of all primitive type kinds.
A CSDL Property element.
The edm:PropertyPath expression provides a value for terms or term properties that specify the built-in
abstract type Edm.PropertyPath.
The edm:PropertyValue element supplies a value to a property on the type instantiated by an
edm:Record expression (See
EdmRecord).The edm:Record expression enables a new entity type or complex type instance to be constructed.
A referential constraint of a navigation property.
An
EdmReturnType of an EdmOperation.A csdl schema element
An
EdmSingleton represents a single entity inside the entity model.EdmStructuralType is the base for a complex type or an entity type.
An
EdmTerm defines a term in a vocabulary.EdmType holds the namespace of a given type and its type as
EdmTypeKind.EdmTyped indicates if an EDM element is of a special type and holds the multiplicity of that type.
An
EdmTypeDefinition defines a specialization of one of the possible primitive types.EdmTypeKind specifies the type of an EDM element.
The edm:UrlRef expression enables a value to be obtained by sending a GET request to the value of
the UrlRef expression.
POJO for Edmx Reference.
edmx:Include elements that specify the schemas to include from the target document.
POJO for Edmx Reference Include Annotation.
Data representation for a single entity.
Data representation for a collection of single entities.
EntityCollection<T extends StructuredType<?>,EC extends Collection<T>,CT extends StructuredCollection<T,EC,?>>
Processor interface for handling a collection of entities, e.g., an Entity Set.
Options for the OData serializer.
Builder of OData serializer options.
Mark POJO as EDM entity container.
Entity context.
Data representation as an Iterator for a collection of single entities.
Processor interface for handling a single instance of an Entity Type.
Options for the OData serializer.
Builder of OData serializer options.
Give entity set a name.
EntitySetInvocationHandler<T extends EntityType<?>,KEY extends Serializable,EC extends EntityCollection<T,?,?>>
Mark POJO as EDM entity type.
Represents a enumeration expression node in the expression tree
A enumeration expression node is inserted in the expression tree for any valid enumeration.
A enumeration expression node is inserted in the expression tree for any valid enumeration.
Mark Java enum as EDM enum type.
Processor which is called if any error/exception occurs inside the library or another processor.
Used for ETag-related tasks.
Represents the expand transformation.
Represents a single resource path which should be expanded with using the system query option $expand
For example: http://...
Represents the system query option $expand
For example: http://...
Super class of all classes used to build the expression tree
Exception class used by the
ExpressionVisitor to throw exceptions while traversing the expression treeGeneric interface to define expression visitors with arbitrary return types.
Represents the filter transformation.
Interface for any available filter argument.
Represents the system query option $filter
For example: http://...
OData serializer for fixed output formats.
Represents the system query option $format
For example: http://...
A full qualified name of any element in the EDM consists of a name and a namespace.
Base class for all geospatial info.
Dimension of the geospatial type
Type of the geospatial type
Wrapper for a collection of geospatials info.
Utilities class for Geography data types.
Represents the grouping transformation.
Represents a grouping property.
Display help information on pojogen-maven-plugin.
Call
Call
mvn pojogen:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.A client-side processing runtime exception.
Interface used by ODataRequest implementations to instantiate HttpClient.
HTTP header constants.
Supported HTTP methods.
HTTP status codes as defined in RFC 7231, section 6,
and additional status codes as defined in RFC 6585
Interface used by ODataRequest implementations to create the HttpUriRequest.
Constant values related to the OData protocol.
Represents the identity transformation.
Represents the system query option $id when using a entity-id to resolve the entity
For example: http://...
InlineEntitySetInvocationHandler<T extends EntityType<?>,KEY extends Serializable,EC extends EntityCollection<T,?,?>>
OData request factory class.
Mark POJO field (property) as key.
Specifies a composite primary key class that is mapped to multiple fields or properties of an EntityType.
Identifies a compound key.
The different types of edm kinds that form the metadata
Used to within a lambda expression tree to define an access to the lambda variable
Represents the system query option $levels when used inside $expand
For example: http://...
Represents a line string.
Data representation for a link.
Data representation for a linked object.
Represents a literal expression node in the expression tree
Literal is not validated by default
Media entity payload object.
Processor interface for handling Entity Media.
Media entity payload object.
Represents a member expression node in the expression tree.
Processor interface for handling the metadata document.
Represents a method expression in the expression tree
Enumeration of supported methods
For the semantic of these methods please see the ODATA specification for URL conventions
Represents a MuliLineString.
Represents a collection of points
Either Edm.GeographyMultiPoint or Edm.GeometryMultiPoint
Represents a collection of polygons.
Associate Java package with OData namespace.
Bind POJO field to EDM navigation property.
Exception to be thrown when trying to read content with HTTP status 204.
PersistenceManager implementation not using OData batch requests: any
read-write operation will be sent separately to the OData service when calling flush().Root object for serving factory tasks and support loose coupling of implementation (core) from the API.
Exception thrown by OData service implementations.
Basic OData request.
Object request that can be sent embedded into a batch request.
Constant values related to the OData protocol.
Batch line iterator class.
Abstract representation of a batch request item.
This class implements a response to a batch request.
Abstract representation of a response item about a batch request.
Changeset wrapper for the corresponding batch item.
Builder to create an ODataClient for the API client library.
Builder class
Represents a client error in OData.
Contains the response content for the OData request.
The ODataContentWriteErrorCallback is called when during the
ODataContent.write(OutputStream)
or the ODataContent.write(WritableByteChannel) an error occurs.The WriteContentErrorErrorContext is the parameter for the WriteContentErrorCallback.
This class implements an OData delete request.
This class implements the response to an OData delete request.
Describes an OData retrieve request returning a delta object.
Interface for de-serialization.
Deserializer on OData server side.
This interface describes an OData create request.
This interface describes the response to an OData entity create request.
Describes an OData retrieve query request returning a single entity.
This class implements an OData EntitySet query request.
This interface describes an OData EntitySet query request.
This class implements an OData update request.
This class implements the response to an OData update request.
OData error.
OData details， for example { "error": {..., "details":[
{"code": "301","target": "$search" ,"message": "$search query option not supported"}
],...}}.
Handles requests as OData requests.
ODataHeaders wraps OData request/response headers.
Handles HTTP requests as OData requests.
This class implements an OData invoke operation request.
This class implements a response to a specific invoke request.
Abstract superclass of all translatable server exceptions.
Key for the exception text in the resource bundle.
Error message text and
Locale used for it.This class implements an OData Media Entity create request.
This class implements the response to an OData media entity create request.
This class implements an OData Media Entity create request.
This class implements the response to an Odata media entity update request.
This class implements an OData media query request.
Core runtime exception for OData.
Retrieve request wrapper for the corresponding batch item.
OData request payload management abstract class.
Values of the Prefer header.
This class implements an OData entity property query request.
This class implements an OData update entity property request.
This class implements the response to an OData update entity property request.
This interface represents a generic OData request.
This interface represents a generic OData response.
OData reader.
This class implements an OData reference adding request.
This class implements the response to an OData Reference Adding request.
Abstract representation of an OData request.
Request object to carry HTTP information optimized for and required to handle OData requests only.
Abstract representation of an OData response.
Response object to carry OData-relevant HTTP information (status code, response headers, and content).
An ODataResponsePart represents a collection of ODataResponses.
This is an abstract representation of an OData retrieve query request returning one or more result item.
This class implements a response to a specific query request.
Core runtime exception for OData.
Interface for serialization.
OData serializer
Class to hold all server relevant error information.
Represents a server error in OData.
This class implements an OData service document request.
This class is a container for the supported ODataServiceVersions.
Retrieve request wrapper for the corresponding batch item.
Abstract class representing a request concerning a streamed entity.
Streamed OData request interface.
Streamer utility object.
This class implements an OData stream create/update request.
This class implements the response to an Odata stream create/update request.
This class implements an OData entity property value query request.
This class implements an OData update entity property value request.
This class implements the response to an OData update entity property request.
OData writer.
Marker interface for all possible Olingo extensions.
Data representation for an operation.
Mark method as EDM function import.
Represents the orderby transformation.
Represents a single orderby information
For example: http://...
Represents the system query option $orderby
For example: http://...
Data representation for a parameter.
Function import parameter information.
Interface for container operations.
Represents a point, either Edm.GeographyPoint or Edm.GeometryPoint.
Polygon.
This exception is thrown for invalid precondition error cases.
Names of preferences defined in the OData standard.
Provides access methods to the preferences set in Prefer HTTP request headers
as described in RFC 7240.
Generic preference object.
Provides methods to set values suitable for the Preference-Applied HTTP response header
as described in RFC 7240.
Builder of OData serializer options.
Processor interface for handling a collection of primitive-type instances, e.g.,
a property of an entity defined as collection of primitive-type instances.
Processor interface for handling an instance of a primitive type, e.g., a primitive property of an entity.
Options for the OData serializer.
Builder of OData serializer options.
Processor interface for handling an instance of a primitive type, e.g., a primitive property of an entity.
Options for the OData serializer.
Builder of OData serializer options.
Base interface for all processor types.
Data representation for a property.
Bind POJO field to EDM property.
Enumeration for all OData property types.
Query options.
Super interface used for any query option
Processor interface for handling a collection an Entity References.
Options to pass as additional information to the reference-collection serializer.
Builder of OData serializer options.
Processor interface for handling a single instance of an Entity Reference.
Options to pass as additional information to the reference serializer.
Builder of OData serializer options.
Annotate navigation property with information about referential constraint.
The different types of representations that form the body of either the
OData request or the OData response, primarily used for content negotiation.
Outermost response payload wrapper.
Mark inner class as EDM row type.
Runtime measurements.
Interface used to control search execution.
Represents the search transformation.
Represents the system query option $search
For example: http://...
URI Segment types.
Represents a single select item information
For example: http://...
Represents the system query option $select
For example: http://...
Exception thrown by the
ODataSerializer.Keys for exception texts in the resource bundle.
Result type for
ODataSerializer methodsResult type for
ODataSerializer methods
which supports streaming (write in the future).REST resource for an ODataServiceDocument.
Processor interface for handling the service document.
Metadata of an OData service like the Entity Data Model.
Register implementations for this interface in oder to support etags for the metadata document and service document.
Give singleton a name.
Represents the skip transformation.
Represents the system query option $skip
For example: http://...
Represents the system query option $skiptoken
For example: http://...
Sort option for queries.
Enumeration for sort directions.
A geometry or geography property MAY define a value for the SRID attribute.
Streamed entity payload object.
StructuredCollection<T extends StructuredType<?>,EC extends Collection<T>,CT extends StructuredCollection<T,EC,?>>
Marker interface for Entity and complex type.
Marker interface for Entity and complex type.
Super interface used for any system query option
Defines the supported system query options.
Mark POJO as term.
Represents the top transformation.
Represents the system query option $top
For example: http://...
PersistenceManager implementation using OData batch requests to implement
high-level user transactions: all read-write operations will be packed in a batch request to the OData service when
calling flush().Represents a type literal expression in the expression tree
Represents a unary expression node in the expression tree
A binary expression node is inserted in the expression tree for any valid ODATA unary operator in
A binary expression node is inserted in the expression tree for any valid ODATA unary operator in
UnaryOperatorKindEnumeration of supported unary operators
For the semantic of these operators please see the ODATA specification for URL conventions
For the semantic of these operators please see the ODATA specification for URL conventions
Update type.
Interface for any available filter; obtain instances via FilterFactory.
Used for URI-related tasks.
Object acting as general access to URI information extracted from the request URI.
Used for URI info kind
UriInfoKind.all to describe URIs like
http://...Used for URI info kind
UriInfoKind.batch to describe URIs like
http://...Used for URI info kind
UriInfoKind.crossjoin to describe URIs like
http://...Used for URI info kind
UriInfoKind.entityId to describe URIs like
http://...Defining the various info kinds
Used for URI info kind
UriInfoKind.metadata to describe URIs like
http://...Used for URI info kind
UriInfoKind.resource to describe URIs like
E.g. http://...Used for URI info kind
UriInfoKind.service to describe URIs like
http://...Represents a function parameter or key predicate when used in the URI.
Super interface for all objects representing resource parts.
Used to describe an action used within an resource path
For example: http://...
Used to describe an complex property used within an resource path
E.g. http://...
Used to describe an $count used within an resource path
For example: http://...
Used to describe an entity set used within an resource path
For example: http://...
Used to describe an function import or bound function used within an resource path
For example: http://...
Class indicating the $it reference.
Defining the various resource part types
Used to describe an all lambda expression used within an resource path
For example: http://...
Used to describe an any lambda expression used within an resource path
For example: http://...
Used to describe an lambda variable used within an resource path
For example: http://...
Used to describe an navigation property used within an resource path
For example: http://...
Used to describe an typed resource part (super interface)
Used to describe an primitive property used within an resource path
For example: http://...
Used to describe an resource part which is an property (super interface)
Used to describe an $ref used within an resource path
For example: http://...
Class indicating the $root reference.
Used to describe an entity set used within an resource path
For example: http://...
Used to describe an $value used within an resource path
For example: http://...
Interface for $search; obtain instances via SearchFactory.
POJOs generator.
Defines a value with an according type.
Defines the type of a value (see Valuable).
Marks an expression node a visitable by an expression visitor
Entry point for access information about EDM metadata.
This class implements an XML metadata request.