Repository: olingo-odata4 Updated Branches: refs/heads/master 9f6c06391 -> e8b2873e8
[OLINGO-143] All edm classes are documented with javadoc Also deleted the EdmTargetPath again since it is not needed in V4 Project: http://git-wip-us.apache.org/repos/asf/olingo-odata4/repo Commit: http://git-wip-us.apache.org/repos/asf/olingo-odata4/commit/e8b2873e Tree: http://git-wip-us.apache.org/repos/asf/olingo-odata4/tree/e8b2873e Diff: http://git-wip-us.apache.org/repos/asf/olingo-odata4/diff/e8b2873e Branch: refs/heads/master Commit: e8b2873e82d791ff0187f875072dbf7d42e4c6b6 Parents: 9f6c063 Author: Christian Amend <[email protected]> Authored: Fri Apr 4 17:37:31 2014 +0200 Committer: Christian Amend <[email protected]> Committed: Fri Apr 4 17:39:41 2014 +0200 ---------------------------------------------------------------------- .../org/apache/olingo/commons/api/edm/Edm.java | 2 +- .../olingo/commons/api/edm/EdmActionImport.java | 2 +- .../olingo/commons/api/edm/EdmElement.java | 2 +- .../commons/api/edm/EdmEntitySetInfo.java | 1 - .../commons/api/edm/EdmKeyPropertyRef.java | 3 ++ .../api/edm/EdmNavigationPropertyBinding.java | 12 ++++- .../api/edm/EdmReferentialConstraint.java | 10 +++- .../olingo/commons/api/edm/EdmSchema.java | 3 ++ .../apache/olingo/commons/api/edm/Target.java | 36 +++++++++----- .../api/edm/constants/EdmTargetPath.java | 50 -------------------- 10 files changed, 52 insertions(+), 69 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java index 32e6fc8..48230d6 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Edm.java @@ -28,7 +28,7 @@ import java.util.List; public interface Edm { /** - * This method DOES NOT support lazy loading. All schemas are loaded completely! + * This method <b>DOES NOT</b> support lazy loading. All schemas are loaded completely! * * @return all schemas defined for this EDM */ http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmActionImport.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmActionImport.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmActionImport.java index e44d45a..39a0db2 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmActionImport.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmActionImport.java @@ -19,7 +19,7 @@ package org.apache.olingo.commons.api.edm; /** - * An EdmActionImport. + * An EdmActionImport element. */ public interface EdmActionImport extends EdmOperationImport { http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmElement.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmElement.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmElement.java index 3076d22..7abfc25 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmElement.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmElement.java @@ -23,5 +23,5 @@ package org.apache.olingo.commons.api.edm; * {@link EdmParameter}. */ public interface EdmElement extends EdmNamed, EdmTyped { -//Should we introduce an element kind? + } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntitySetInfo.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntitySetInfo.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntitySetInfo.java index fe19708..9b5405d 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntitySetInfo.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmEntitySetInfo.java @@ -25,7 +25,6 @@ import java.net.URI; */ public interface EdmEntitySetInfo { - // TODO: Either make this a class or alias info an interface! /** * @return the entity container name which contains this entity set. */ http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmKeyPropertyRef.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmKeyPropertyRef.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmKeyPropertyRef.java index 18cbd9b..3b2b932 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmKeyPropertyRef.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmKeyPropertyRef.java @@ -18,6 +18,9 @@ */ package org.apache.olingo.commons.api.edm; +/** + * A key property reference element. + */ public interface EdmKeyPropertyRef { /** http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationPropertyBinding.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationPropertyBinding.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationPropertyBinding.java index 2ebcf2b..363d5b7 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationPropertyBinding.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmNavigationPropertyBinding.java @@ -18,11 +18,21 @@ */ package org.apache.olingo.commons.api.edm; -//TODO: JavaDoc +/** + * A navigation property binding which binds entity sets or singletons with each other. + */ public interface EdmNavigationPropertyBinding { + /** + * A path contains the full qualified name of the type it is referring to as a first segment. If it is a type + * nested inside another type the path is separated by forward slashes. + * @return path which leads to the target. + */ String getPath(); + /** + * @return the entity set or singleton this binding refers to. + */ String getTarget(); } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmReferentialConstraint.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmReferentialConstraint.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmReferentialConstraint.java index e479efb..f30dea5 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmReferentialConstraint.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmReferentialConstraint.java @@ -18,11 +18,19 @@ */ package org.apache.olingo.commons.api.edm; -//TODO: Document +/** + * A referential constraint of a navigation property. + */ public interface EdmReferentialConstraint { + /** + * @return property name of the property inside this entity type or complex type. + */ String getPropertyName(); + /** + * @return property name of the referenced entity type or complex type. + */ String getReferencedPropertyName(); } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmSchema.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmSchema.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmSchema.java index 993691c..73dcdfb 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmSchema.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/EdmSchema.java @@ -83,6 +83,9 @@ public interface EdmSchema { */ EdmEntityContainer getEntityContainer(FullQualifiedName name); + /** + * @return all {@link EdmTypeDefinition} for this schema. + */ List<EdmTypeDefinition> getTypeDefinitions(); } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Target.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Target.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Target.java index 3bee0bd..122e670 100644 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Target.java +++ b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/Target.java @@ -1,23 +1,27 @@ -/* +/* * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file + * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file + * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the + * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ package org.apache.olingo.commons.api.edm; +/** + * An Edm target element. It contains a target as a String name as well as the {@link FullQualifiedName} of the entity + * container it is contained in. + */ public class Target { private String targetName; @@ -34,14 +38,14 @@ public class Target { instance = new Target(); if (bindingTargetParts.length == 1) { instance. - setEntityContainer(new FullQualifiedName(defaultContainer.getNamespace(), defaultContainer.getName())). - setTargetName(bindingTargetParts[0]); + setEntityContainer(new FullQualifiedName(defaultContainer.getNamespace(), defaultContainer.getName())). + setTargetName(bindingTargetParts[0]); } else { final int idx = bindingTargetParts[0].lastIndexOf('.'); instance. - setEntityContainer(new FullQualifiedName( - bindingTargetParts[0].substring(0, idx), bindingTargetParts[0].substring(idx))). - setTargetName(bindingTargetParts[1]); + setEntityContainer(new FullQualifiedName( + bindingTargetParts[0].substring(0, idx), bindingTargetParts[0].substring(idx))). + setTargetName(bindingTargetParts[1]); } } @@ -50,6 +54,9 @@ public class Target { } } + /** + * @return name of the target as a String + */ public String getTargetName() { return targetName; } @@ -59,6 +66,9 @@ public class Target { return this; } + /** + * @return {@link FullQualifiedName} of the entity container this target is contained in. + */ public FullQualifiedName getEntityContainer() { return entityContainer; } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/e8b2873e/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/EdmTargetPath.java ---------------------------------------------------------------------- diff --git a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/EdmTargetPath.java b/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/EdmTargetPath.java deleted file mode 100644 index 37ca4ca..0000000 --- a/lib/commons-api/src/main/java/org/apache/olingo/commons/api/edm/constants/EdmTargetPath.java +++ /dev/null @@ -1,50 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ -package org.apache.olingo.commons.api.edm.constants; - -/** - * EdmTargetPath specifies the possible default targets for an EDM property which is mapped to an atom element. - */ -public class EdmTargetPath { - - public static final String SYNDICATION_AUTHORNAME = "SyndicationAuthorName"; - - public static final String SYNDICATION_AUTHOREMAIL = "SyndicationAuthorEmail"; - - public static final String SYNDICATION_AUTHORURI = "SyndicationAuthorUri"; - - public static final String SYNDICATION_PUBLISHED = "SyndicationPublished"; - - public static final String SYNDICATION_RIGHTS = "SyndicationRights"; - - public static final String SYNDICATION_TITLE = "SyndicationTitle"; - - public static final String SYNDICATION_UPDATED = "SyndicationUpdated"; - - public static final String SYNDICATION_CONTRIBUTORNAME = "SyndicationContributorName"; - - public static final String SYNDICATION_CONTRIBUTOREMAIL = "SyndicationContributorEmail"; - - public static final String SYNDICATION_CONTRIBUTORURI = "SyndicationContributorUri"; - - public static final String SYNDICATION_SOURCE = "SyndicationSource"; - - public static final String SYNDICATION_SUMMARY = "SyndicationSummary"; - -}
