[OLINGO-756][OLINGO-713] Support in sqo-es tutorial
This commit is contained in:
parent
dc44d7c998
commit
790ec76011
|
@ -27,9 +27,11 @@ import org.apache.olingo.commons.api.data.ContextURL;
|
||||||
import org.apache.olingo.commons.api.data.Entity;
|
import org.apache.olingo.commons.api.data.Entity;
|
||||||
import org.apache.olingo.commons.api.data.EntityCollection;
|
import org.apache.olingo.commons.api.data.EntityCollection;
|
||||||
import org.apache.olingo.commons.api.data.Link;
|
import org.apache.olingo.commons.api.data.Link;
|
||||||
|
import org.apache.olingo.commons.api.edm.EdmElement;
|
||||||
import org.apache.olingo.commons.api.edm.EdmEntitySet;
|
import org.apache.olingo.commons.api.edm.EdmEntitySet;
|
||||||
import org.apache.olingo.commons.api.edm.EdmEntityType;
|
import org.apache.olingo.commons.api.edm.EdmEntityType;
|
||||||
import org.apache.olingo.commons.api.edm.EdmNavigationProperty;
|
import org.apache.olingo.commons.api.edm.EdmNavigationProperty;
|
||||||
|
import org.apache.olingo.commons.api.edm.EdmNavigationPropertyBinding;
|
||||||
import org.apache.olingo.commons.api.format.ContentType;
|
import org.apache.olingo.commons.api.format.ContentType;
|
||||||
import org.apache.olingo.commons.api.format.ODataFormat;
|
import org.apache.olingo.commons.api.format.ODataFormat;
|
||||||
import org.apache.olingo.commons.api.http.HttpHeader;
|
import org.apache.olingo.commons.api.http.HttpHeader;
|
||||||
|
@ -100,15 +102,35 @@ public class DemoEntityCollectionProcessor implements EntityCollectionProcessor
|
||||||
// in our example: http://localhost:8080/DemoService/DemoService.svc/Categories/$expand=Products
|
// in our example: http://localhost:8080/DemoService/DemoService.svc/Categories/$expand=Products
|
||||||
// or http://localhost:8080/DemoService/DemoService.svc/Products?$expand=Category
|
// or http://localhost:8080/DemoService/DemoService.svc/Products?$expand=Category
|
||||||
if (expandOption != null) {
|
if (expandOption != null) {
|
||||||
|
|
||||||
// retrieve the EdmNavigationProperty from the expand expression
|
// retrieve the EdmNavigationProperty from the expand expression
|
||||||
// Note: in our example, we have only one NavigationProperty, so we can directly access it
|
// Note: in our example, we have only one NavigationProperty, so we can directly access it
|
||||||
|
EdmNavigationProperty edmNavigationProperty = null;
|
||||||
ExpandItem expandItem = expandOption.getExpandItems().get(0);
|
ExpandItem expandItem = expandOption.getExpandItems().get(0);
|
||||||
// can be 'Category' or 'Products'
|
if(expandItem.isStar()) {
|
||||||
|
List<EdmNavigationPropertyBinding> bindings = edmEntitySet.getNavigationPropertyBindings();
|
||||||
|
// we know that there are navigation bindings
|
||||||
|
// however normally in this case a check if navigation bindings exists is done
|
||||||
|
if(!bindings.isEmpty()) {
|
||||||
|
// can in our case only be 'Category' or 'Products', so we can take the first
|
||||||
|
EdmNavigationPropertyBinding binding = bindings.get(0);
|
||||||
|
EdmElement property = edmEntitySet.getEntityType().getProperty(binding.getPath());
|
||||||
|
// we don't need to handle error cases, as it is done in the Olingo library
|
||||||
|
if(property instanceof EdmNavigationProperty) {
|
||||||
|
edmNavigationProperty = (EdmNavigationProperty) property;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// can be 'Category' or 'Products', no path supported
|
||||||
UriResource uriResource = expandItem.getResourcePath().getUriResourceParts().get(0);
|
UriResource uriResource = expandItem.getResourcePath().getUriResourceParts().get(0);
|
||||||
// we don't need to handle error cases, as it is done in the Olingo library
|
// we don't need to handle error cases, as it is done in the Olingo library
|
||||||
if(uriResource instanceof UriResourceNavigation) {
|
if(uriResource instanceof UriResourceNavigation) {
|
||||||
EdmNavigationProperty edmNavigationProperty = ((UriResourceNavigation) uriResource).getProperty();
|
edmNavigationProperty = ((UriResourceNavigation) uriResource).getProperty();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// can be 'Category' or 'Products', no path supported
|
||||||
|
// we don't need to handle error cases, as it is done in the Olingo library
|
||||||
|
if(edmNavigationProperty != null) {
|
||||||
String navPropName = edmNavigationProperty.getName();
|
String navPropName = edmNavigationProperty.getName();
|
||||||
EdmEntityType expandEdmEntityType = edmNavigationProperty.getType();
|
EdmEntityType expandEdmEntityType = edmNavigationProperty.getType();
|
||||||
|
|
||||||
|
|
|
@ -29,9 +29,11 @@ import org.apache.olingo.commons.api.data.ContextURL.Suffix;
|
||||||
import org.apache.olingo.commons.api.data.Entity;
|
import org.apache.olingo.commons.api.data.Entity;
|
||||||
import org.apache.olingo.commons.api.data.EntityCollection;
|
import org.apache.olingo.commons.api.data.EntityCollection;
|
||||||
import org.apache.olingo.commons.api.data.Link;
|
import org.apache.olingo.commons.api.data.Link;
|
||||||
|
import org.apache.olingo.commons.api.edm.EdmElement;
|
||||||
import org.apache.olingo.commons.api.edm.EdmEntitySet;
|
import org.apache.olingo.commons.api.edm.EdmEntitySet;
|
||||||
import org.apache.olingo.commons.api.edm.EdmEntityType;
|
import org.apache.olingo.commons.api.edm.EdmEntityType;
|
||||||
import org.apache.olingo.commons.api.edm.EdmNavigationProperty;
|
import org.apache.olingo.commons.api.edm.EdmNavigationProperty;
|
||||||
|
import org.apache.olingo.commons.api.edm.EdmNavigationPropertyBinding;
|
||||||
import org.apache.olingo.commons.api.format.ContentType;
|
import org.apache.olingo.commons.api.format.ContentType;
|
||||||
import org.apache.olingo.commons.api.format.ODataFormat;
|
import org.apache.olingo.commons.api.format.ODataFormat;
|
||||||
import org.apache.olingo.commons.api.http.HttpHeader;
|
import org.apache.olingo.commons.api.http.HttpHeader;
|
||||||
|
@ -71,59 +73,6 @@ public class DemoEntityProcessor implements EntityProcessor {
|
||||||
this.srvMetadata = serviceMetadata;
|
this.srvMetadata = serviceMetadata;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
// /**
|
|
||||||
// * DUMMY example implementation
|
|
||||||
// * */
|
|
||||||
// public void readEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat)
|
|
||||||
// throws ODataApplicationException, SerializerException {
|
|
||||||
//
|
|
||||||
// // 1. Analyze the URI
|
|
||||||
// EdmEntitySet edmEntitySet = ((UriResourceEntitySet)uriInfo.getUriResourceParts().get(0)).getEntitySet();
|
|
||||||
// // get the system query option $expand
|
|
||||||
// ExpandOption expandOption = uriInfo.getExpandOption();
|
|
||||||
//
|
|
||||||
// // 2. get the data.
|
|
||||||
//
|
|
||||||
// // Note: this is FAKE implementation
|
|
||||||
// // used for following request:
|
|
||||||
// // http://localhost:8080/DemoService/DemoService.svc/Products(1)?$expand=Category
|
|
||||||
//
|
|
||||||
// // create hard-coded product entity and set a hard-coded category as inlineEntity for the expand
|
|
||||||
// Entity fakeProductEntity = new Entity().addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 11))
|
|
||||||
// .addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Gamer Mouse"));
|
|
||||||
// fakeProductEntity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE, "High end gaming mouse"));
|
|
||||||
//
|
|
||||||
// // create hard-coded category entity (the target of the $expand)
|
|
||||||
// Entity fakeCategoryEntity = new Entity().addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 22))
|
|
||||||
// .addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Mice"));
|
|
||||||
//
|
|
||||||
// // create navigation link from product to category
|
|
||||||
// Link fakeLink = new Link();
|
|
||||||
// fakeLink.setTitle("Category"); // hard-code the name of the navigation property as declared in EdmProvider
|
|
||||||
// fakeLink.setInlineEntity(fakeCategoryEntity); // the entity which will be expanded
|
|
||||||
//
|
|
||||||
// //add the link to the product entity
|
|
||||||
// fakeProductEntity.getNavigationLinks().add(fakeLink);
|
|
||||||
//
|
|
||||||
// // END FAKE
|
|
||||||
//
|
|
||||||
//
|
|
||||||
// // 3. serialize
|
|
||||||
// ContextURL contextUrl = ContextURL.with().entitySet(edmEntitySet).suffix(ContextURL.Suffix.ENTITY).build();
|
|
||||||
// // $expand info is added to the serializer options
|
|
||||||
// EntitySerializerOptions options = EntitySerializerOptions.with().contextURL(contextUrl).expand(expandOption).build();
|
|
||||||
// ODataSerializer serializer = this.odata.createSerializer(ODataFormat.fromContentType(responseFormat));
|
|
||||||
// SerializerResult serializerResult = serializer.entity(srvMetadata, edmEntitySet.getEntityType(), fakeProductEntity, options);
|
|
||||||
//
|
|
||||||
// //4. configure the response object
|
|
||||||
// response.setContent(serializerResult.getContent());
|
|
||||||
// response.setStatusCode(HttpStatusCode.OK.getStatusCode());
|
|
||||||
// response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString());
|
|
||||||
// }
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
public void readEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat)
|
public void readEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat)
|
||||||
throws ODataApplicationException, SerializerException {
|
throws ODataApplicationException, SerializerException {
|
||||||
|
|
||||||
|
@ -149,15 +98,35 @@ public class DemoEntityProcessor implements EntityProcessor {
|
||||||
// in our example: http://localhost:8080/DemoService/DemoService.svc/Categories(1)/$expand=Products
|
// in our example: http://localhost:8080/DemoService/DemoService.svc/Categories(1)/$expand=Products
|
||||||
// or http://localhost:8080/DemoService/DemoService.svc/Products(1)?$expand=Category
|
// or http://localhost:8080/DemoService/DemoService.svc/Products(1)?$expand=Category
|
||||||
if(expandOption != null) {
|
if(expandOption != null) {
|
||||||
|
|
||||||
// retrieve the EdmNavigationProperty from the expand expression
|
// retrieve the EdmNavigationProperty from the expand expression
|
||||||
// Note: in our example, we have only one NavigationProperty, so we can directly access it
|
// Note: in our example, we have only one NavigationProperty, so we can directly access it
|
||||||
|
EdmNavigationProperty edmNavigationProperty = null;
|
||||||
ExpandItem expandItem = expandOption.getExpandItems().get(0);
|
ExpandItem expandItem = expandOption.getExpandItems().get(0);
|
||||||
|
if(expandItem.isStar()) {
|
||||||
|
List<EdmNavigationPropertyBinding> bindings = edmEntitySet.getNavigationPropertyBindings();
|
||||||
|
// we know that there are navigation bindings
|
||||||
|
// however normally in this case a check if navigation bindings exists is done
|
||||||
|
if(!bindings.isEmpty()) {
|
||||||
|
// can in our case only be 'Category' or 'Products', so we can take the first
|
||||||
|
EdmNavigationPropertyBinding binding = bindings.get(0);
|
||||||
|
EdmElement property = edmEntitySet.getEntityType().getProperty(binding.getPath());
|
||||||
|
// we don't need to handle error cases, as it is done in the Olingo library
|
||||||
|
if(property instanceof EdmNavigationProperty) {
|
||||||
|
edmNavigationProperty = (EdmNavigationProperty) property;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
// can be 'Category' or 'Products', no path supported
|
// can be 'Category' or 'Products', no path supported
|
||||||
UriResource uriResource = expandItem.getResourcePath().getUriResourceParts().get(0);
|
UriResource uriResource = expandItem.getResourcePath().getUriResourceParts().get(0);
|
||||||
// we don't need to handle error cases, as it is done in the Olingo library
|
// we don't need to handle error cases, as it is done in the Olingo library
|
||||||
if(uriResource instanceof UriResourceNavigation) {
|
if(uriResource instanceof UriResourceNavigation) {
|
||||||
EdmNavigationProperty edmNavigationProperty = ((UriResourceNavigation)uriResource).getProperty();
|
edmNavigationProperty = ((UriResourceNavigation) uriResource).getProperty();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// can be 'Category' or 'Products', no path supported
|
||||||
|
// we don't need to handle error cases, as it is done in the Olingo library
|
||||||
|
if(edmNavigationProperty != null) {
|
||||||
EdmEntityType expandEdmEntityType = edmNavigationProperty.getType();
|
EdmEntityType expandEdmEntityType = edmNavigationProperty.getType();
|
||||||
String navPropName = edmNavigationProperty.getName();
|
String navPropName = edmNavigationProperty.getName();
|
||||||
|
|
||||||
|
@ -184,7 +153,6 @@ public class DemoEntityProcessor implements EntityProcessor {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// 4. serialize
|
// 4. serialize
|
||||||
EdmEntityType edmEntityType = edmEntitySet.getEntityType();
|
EdmEntityType edmEntityType = edmEntitySet.getEntityType();
|
||||||
// we need the property names of the $select, in order to build the context URL
|
// we need the property names of the $select, in order to build the context URL
|
||||||
|
|
|
@ -30,12 +30,18 @@ under the License.
|
||||||
<li>
|
<li>
|
||||||
<a href="DemoService.svc/Products/?$expand=Category">Expand - /Products/?$expand=Category</a>
|
<a href="DemoService.svc/Products/?$expand=Category">Expand - /Products/?$expand=Category</a>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="DemoService.svc/Products(1)/?$expand=*">Expand - /Products(1)/?$expand=*</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="DemoService.svc/Categories(1)/?$expand=Products">Expand - /Categories(1)/?$expand=Products</a>
|
<a href="DemoService.svc/Categories(1)/?$expand=Products">Expand - /Categories(1)/?$expand=Products</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="DemoService.svc/Categories/?$expand=Products">Expand - /Categories/?$expand=Products</a>
|
<a href="DemoService.svc/Categories/?$expand=Products">Expand - /Categories/?$expand=Products</a>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="DemoService.svc/Categories/?$expand=*">Expand - /Categories/?$expand=*</a>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue