Author: ppoddar
Date: Fri Dec 21 18:31:40 2012
New Revision: 1425073
URL: http://svn.apache.org/viewvc?rev=1425073&view=rev
Log:
Add javadoc comments
Modified:
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PathImpl.java
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PredicateImpl.java
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/meta/Members.java
Modified:
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PathImpl.java
URL:
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PathImpl.java?rev=1425073&r1=1425072&r2=1425073&view=diff
==============================================================================
---
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PathImpl.java
(original)
+++
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PathImpl.java
Fri Dec 21 18:31:40 2012
@@ -19,6 +19,8 @@
package org.apache.openjpa.persistence.criteria;
+import java.util.Arrays;
+
import javax.persistence.criteria.Expression;
import javax.persistence.criteria.Join;
import javax.persistence.criteria.JoinType;
@@ -31,6 +33,7 @@ import javax.persistence.metamodel.Singu
import javax.persistence.metamodel.Type;
import javax.persistence.metamodel.Type.PersistenceType;
+import org.apache.openjpa.jdbc.meta.FieldMapping;
import org.apache.openjpa.kernel.exps.ExpressionFactory;
import org.apache.openjpa.kernel.exps.Value;
import org.apache.openjpa.meta.ClassMetaData;
@@ -39,12 +42,7 @@ import org.apache.openjpa.persistence.me
import org.apache.openjpa.persistence.meta.Members.Member;
/**
- * Represents a simple or compound attribute path from a
- * bound type or collection, and is a "primitive" expression.
- * @param <X> Type referenced by the path
- */
-/**
- * Path is an expression often representing a persistent attribute traversed
from another (parent) path.
+ * Path is an expression representing a persistent attribute traversed from a
parent path.
* The type of the path is the type of the persistent attribute.
* If the persistent attribute is bindable, then further path can be traversed
from this path.
*
@@ -70,8 +68,11 @@ class PathImpl<Z,X> extends ExpressionIm
}
/**
- * Create a path from the given non-null parent representing the given
non-null member. The given class denotes
- * the type expressed by this path.
+ * Create a path from the given parent representing the given member.
+ *
+ * @param parent the path from which this path needs to be constructed.
Must not be null.
+ * @param member the persistent property that represents this path.
+ * @param cls denotes the type expressed by this path.
*/
public PathImpl(PathImpl<?,Z> parent, Members.Member<? super Z, ?> member,
Class<X> cls) {
super(cls);
@@ -87,8 +88,9 @@ class PathImpl<Z,X> extends ExpressionIm
}
/**
- * Returns the bindable object that corresponds to the path expression.
+ * Gets the bindable object that corresponds to the path expression.
*
+ * @throws IllegalArgumentException if this path is not bindable
*/
public Bindable<X> getModel() {
if (_member instanceof Bindable<?> == false) {
@@ -98,28 +100,33 @@ class PathImpl<Z,X> extends ExpressionIm
}
/**
- * Return the parent "node" in the path or null if no parent.
+ * Gets the parent of this path or null if this path is the root.
*/
public final Path<Z> getParentPath() {
return _parent;
}
/**
- * Gets the path that originates this traversal. Can be itself if this
itself is the origin.
+ * Gets the path that originates this traversal. Can be itself if this
path is the root.
*/
public PathImpl<?,?> getInnermostParentPath() {
return (_parent == null) ? this : _parent.getInnermostParentPath();
}
+ /**
+ * Gets the field that may have been embedded inside the given field.
+ * For example, a given primary key field which is using an embedded class
as a complex primary key.
+ * @param fmd a given field
+ * @return the embedded field or the given field itself
+ */
protected FieldMetaData getEmbeddedFieldMetaData(FieldMetaData fmd) {
Members.Member<?,?> member = getInnermostMember(_parent,_member);
- ClassMetaData embeddedMeta = member.fmd.isElementCollection() ?
- member.fmd.getElement().getEmbeddedMetaData() :
- member.fmd.getEmbeddedMetaData();
- if (embeddedMeta != null)
- return embeddedMeta.getField(fmd.getName());
- else
- return fmd;
+
+ ClassMetaData embeddedMeta = member.fmd.isElementCollection()
+ ? member.fmd.getElement().getEmbeddedMetaData()
+ : member.fmd.getEmbeddedMetaData();
+
+ return (embeddedMeta != null) ? embeddedMeta.getField(fmd.getName()) :
fmd;
}
protected Members.Member<?,?> getInnermostMember(PathImpl<?,?> parent,
Members.Member<?,?> member) {
@@ -276,6 +283,7 @@ class PathImpl<Z,X> extends ExpressionIm
return _member.getType();
}
+ @SuppressWarnings("unchecked")
public Member<? extends Z, X> getMember() {
return (Member<? extends Z, X>) _member;
}
Modified:
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PredicateImpl.java
URL:
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PredicateImpl.java?rev=1425073&r1=1425072&r2=1425073&view=diff
==============================================================================
---
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PredicateImpl.java
(original)
+++
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/criteria/PredicateImpl.java
Fri Dec 21 18:31:40 2012
@@ -53,6 +53,9 @@ abstract class PredicateImpl extends Exp
private final BooleanOperator _op;
private boolean _negated = false;
+ static {
+ System.err.println("WARNING: You are using a unofficial version of
PredicateImpl.class");
+ }
/**
* An AND predicate with no arguments.
*/
Modified:
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/meta/Members.java
URL:
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/meta/Members.java?rev=1425073&r1=1425072&r2=1425073&view=diff
==============================================================================
---
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/meta/Members.java
(original)
+++
openjpa/trunk/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/meta/Members.java
Fri Dec 21 18:31:40 2012
@@ -20,7 +20,6 @@
package org.apache.openjpa.persistence.meta;
import java.util.Collection;
-import java.util.Set;
import javax.persistence.metamodel.Attribute;
import javax.persistence.metamodel.CollectionAttribute;
@@ -73,6 +72,7 @@ public class Members {
/**
* Returns the managed type which declared this attribute.
*/
+ @SuppressWarnings("unchecked")
public final ManagedType<X> getDeclaringType() {
return
(ManagedType<X>)owner.model.managedType(fmd.getDeclaringType());
}
@@ -87,6 +87,7 @@ public class Members {
/**
* Gets the Java type of this attribute.
*/
+ @SuppressWarnings("unchecked")
public final Class<Y> getJavaType() {
return (Class<Y>)fmd.getDeclaredType();
}
@@ -101,9 +102,11 @@ public class Members {
/**
* Returns the type that represents the type of this attribute.
*/
+ @SuppressWarnings("unchecked")
public final Type<Y> getType() {
- return owner.model.getType(isCollection() ?
- fmd.getElement().getDeclaredType() : fmd.getDeclaredType());
+ return owner.model.getType(isCollection()
+ ? fmd.getElement().getDeclaredType()
+ : fmd.getDeclaredType());
}
/**
@@ -137,6 +140,10 @@ public class Members {
public int compareTo(Member<X, Y> o) {
return fmd.getName().compareTo(o.fmd.getName());
}
+
+ public String toString() {
+ return fmd.getFullName(true);
+ }
}
@@ -190,6 +197,7 @@ public class Members {
* is returned. If the bindable type is SINGULAR_ATTRIBUTE or
ENTITY_TYPE, the Java type
* of the represented entity or attribute is returned.
*/
+ @SuppressWarnings("unchecked")
public final Class<T> getBindableJavaType() {
return fmd.getElement().getDeclaredType();
}
@@ -243,6 +251,7 @@ public class Members {
*
* For PLURAL_ATTRIBUTE, the Java element type is returned.
*/
+ @SuppressWarnings("unchecked")
public Class<E> getBindableJavaType() {
return fmd.getElement().getDeclaredType();
}
@@ -313,6 +322,7 @@ public class Members {
super(owner, fmd);
}
+ @SuppressWarnings("unchecked")
public Class<K> getBindableJavaType() {
return (Class<K>)fmd.getKey().getDeclaredType();
}
@@ -333,6 +343,7 @@ public class Members {
return CollectionType.MAP;
}
+ @SuppressWarnings("unchecked")
public Class<K> getKeyJavaType() {
return fmd.getKey().getDeclaredType();
}
