Author: ieb
Date: Wed Sep 17 04:07:09 2008
New Revision: 696238
URL: http://svn.apache.org/viewvc?rev=696238&view=rev
Log:
SHINDIG-594
More javadoc. Stopping for a moment to do the serivce implementations and
get them into a single commit.
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AccountDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ActivityDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AddressDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/BodyTypeDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ListFieldDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MediaItemDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MessageDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/NameDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationAddressDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationDb.java
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/PersonAccountDb.java
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AccountDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AccountDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AccountDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AccountDb.java
Wed Sep 17 04:07:09 2008
@@ -63,7 +63,7 @@
/**
* model field.
- * @see Account
+ * @see org.apache.shindig.social.opensocial.model.Account
*/
@Basic
@Column(name = "domain", length = 255)
@@ -71,7 +71,7 @@
/**
* model field.
- * @see Account
+ * @see org.apache.shindig.social.opensocial.model.Account
*/
@Basic
@Column(name = "user_id", length = 255)
@@ -79,47 +79,81 @@
/**
* model field.
- * @see Account
+ * @see org.apache.shindig.social.opensocial.model.Account
*/
@Basic
@Column(name = "username", length = 255)
protected String username;
+ /**
+ * create an empty account object.
+ */
public AccountDb() {
}
+ /**
+ * Create an account object based on domain, userId and username
+ * @param domain the domain of the account
+ * @param userId the user id of the account
+ * @param username the username of the account
+ */
public AccountDb(String domain, String userId, String username) {
this.domain = domain;
this.userId = userId;
this.username = username;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Account#getDomain()
+ */
public String getDomain() {
return domain;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Account#setDomain(java.lang.String)
+ */
public void setDomain(String domain) {
this.domain = domain;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Account#getUserId()
+ */
public String getUserId() {
return userId;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Account#setUserId(java.lang.String)
+ */
public void setUserId(String userId) {
this.userId = userId;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Account#getUsername()
+ */
public String getUsername() {
return username;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Account#setUsername(java.lang.String)
+ */
public void setUsername(String username) {
this.username = username;
}
/**
- * @return the objectId
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.jpa.DbObject#getObjectId()
*/
public long getObjectId() {
return objectId;
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ActivityDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ActivityDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ActivityDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ActivityDb.java
Wed Sep 17 04:07:09 2008
@@ -73,7 +73,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "app_id", length = 255)
@@ -81,7 +81,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "body", length = 255)
@@ -89,7 +89,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "body_id", length = 255)
@@ -97,7 +97,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "external_id", length = 255)
@@ -105,7 +105,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "activity_id", length = 255)
@@ -113,7 +113,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "updated")
@@ -136,7 +136,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "posted_time")
@@ -144,7 +144,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "priority")
@@ -152,7 +152,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "stream_favicon_url", length = 255)
@@ -160,7 +160,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "stream_source_url", length = 255)
@@ -168,7 +168,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "stream_title", length = 255)
@@ -176,7 +176,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "stream_url", length = 255)
@@ -201,7 +201,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "title", length = 255)
@@ -209,7 +209,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "title_id", length = 255)
@@ -217,7 +217,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "url", length = 255)
@@ -225,7 +225,7 @@
/**
* model field.
- * @see Activity
+ * @see org.apache.shindig.social.opensocial.model.Activity
*/
@Basic
@Column(name = "user_id", length = 255)
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AddressDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AddressDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AddressDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/AddressDb.java
Wed Sep 17 04:07:09 2008
@@ -85,7 +85,7 @@
/**
* model field.
- * @see Address
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "country", length = 255)
@@ -93,7 +93,7 @@
/**
* model field.
- * @see Address
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "latitude")
@@ -101,7 +101,7 @@
/**
* model field.
- * @see Address
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "longitude")
@@ -109,7 +109,7 @@
/**
* model field.
- * @see Address
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "locality", length = 255)
@@ -117,7 +117,7 @@
/**
* model field.
- * @see Address
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "postal_code", length = 255)
@@ -125,7 +125,7 @@
/**
* model field.
- * @see Address
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "region", length = 255)
@@ -133,7 +133,7 @@
/**
* model field.
- * @see Address
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "street_address", length = 255)
@@ -141,7 +141,7 @@
/**
* model field.
- * @see Address
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "type", length = 255)
@@ -149,15 +149,15 @@
/**
* model field.
- * @see Address
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "formatted", length = 255)
private String formatted;
/**
- * model field.
- * @see Address
+ * model field.
+ * @see org.apache.shindig.social.opensocial.model.Address
*/
@Basic
@Column(name = "primary_address")
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/BodyTypeDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/BodyTypeDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/BodyTypeDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/BodyTypeDb.java
Wed Sep 17 04:07:09 2008
@@ -76,7 +76,7 @@
/**
* model field.
- * @see BodyType
+ * @see org.apache.shindig.social.opensocial.model.BodyType
*/
@Basic
@Column(name = "build", length = 255)
@@ -84,7 +84,7 @@
/**
* model field.
- * @see BodyType
+ * @see org.apache.shindig.social.opensocial.model.BodyType
*/
@Basic
@Column(name = "eye_color", length = 255)
@@ -92,7 +92,7 @@
/**
* model field.
- * @see BodyType
+ * @see org.apache.shindig.social.opensocial.model.BodyType
*/
@Basic
@Column(name = "hair_color", length = 255)
@@ -100,7 +100,7 @@
/**
* model field.
- * @see BodyType
+ * @see org.apache.shindig.social.opensocial.model.BodyType
*/
@Basic
@Column(name = "height", length = 255)
@@ -108,7 +108,7 @@
/**
* model field.
- * @see BodyType
+ * @see org.apache.shindig.social.opensocial.model.BodyType
*/
@Basic
@Column(name = "weight", length = 255)
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ListFieldDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ListFieldDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ListFieldDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/ListFieldDb.java
Wed Sep 17 04:07:09 2008
@@ -65,7 +65,7 @@
/**
* model field.
- * @see ListField
+ * @see org.apache.shindig.social.opensocial.model.ListField
*/
@Basic
@Column(name="field_type", length=255)
@@ -73,7 +73,7 @@
/**
* model field.
- * @see ListField
+ * @see org.apache.shindig.social.opensocial.model.ListField
*/
@Basic
@Column(name="field_value", length=255)
@@ -81,7 +81,7 @@
/**
* model field.
- * @see ListField
+ * @see org.apache.shindig.social.opensocial.model.ListField
*/
@Basic
@Column(name="primary_field")
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MediaItemDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MediaItemDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MediaItemDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MediaItemDb.java
Wed Sep 17 04:07:09 2008
@@ -70,7 +70,7 @@
/**
* model field.
- * @see MediaItem
+ * @see org.apache.shindig.social.opensocial.model.MediaItem
*/
@Basic
@Column(name = "mime_type", length = 255)
@@ -78,7 +78,7 @@
/**
* model field.
- * @see MediaItem
+ * @see org.apache.shindig.social.opensocial.model.MediaItem
*/
@Basic
@Column(name = "media_type")
@@ -86,14 +86,14 @@
/**
* model field.
- * @see MediaItem
+ * @see org.apache.shindig.social.opensocial.model.MediaItem
*/
@Transient
private Type type;
/**
* model field.
- * @see MediaItem
+ * @see org.apache.shindig.social.opensocial.model.MediaItem
*/
@Basic
@Column(name = "url", length = 255)
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MessageDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MessageDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MessageDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/MessageDb.java
Wed Sep 17 04:07:09 2008
@@ -56,7 +56,7 @@
/**
* model field.
- * @see Message
+ * @see org.apache.shindig.social.opensocial.model.Message
*/
@Basic
@Column(name="body", length=255)
@@ -64,7 +64,7 @@
/**
* model field.
- * @see Message
+ * @see org.apache.shindig.social.opensocial.model.Message
*/
@Basic
@Column(name="title", length=255)
@@ -72,7 +72,7 @@
/**
* model field. (database representation of type)
- * @see Message
+ * @see org.apache.shindig.social.opensocial.model.Message
*/
@Basic
@Column(name="message_type")
@@ -80,7 +80,7 @@
/**
* model field.
- * @see Message
+ * @see org.apache.shindig.social.opensocial.model.Message
*/
@Transient
protected Type type;
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/NameDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/NameDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/NameDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/NameDb.java
Wed Sep 17 04:07:09 2008
@@ -34,12 +34,20 @@
import java.util.List;
+/**
+ * The name object, stored in the name table.
+ */
@Entity
@Table(name = "name")
[EMAIL PROTECTED](name = NameDb.FINDBY_FAMILY_NAME,
- query = "select n from NameDb n where n.familyName = :familyName ")
[EMAIL PROTECTED](name = NameDb.FINDBY_FAMILY_NAME, query = "select n from
NameDb n where n.familyName = :familyName ")
public class NameDb implements Name, DbObject {
+ /**
+ * the name of the JPA query that selects a name by family name.
+ */
public static final String FINDBY_FAMILY_NAME = "q.name.findbyfamilyname";
+ /**
+ * the name of the family name parameter used in JPA named queries.
+ */
public static final String PARAM_FAMILY_NAME = "familyName";
/**
@@ -58,88 +66,182 @@
@Column(name = "version")
protected long version;
+ /**
+ * A list of people who shared this name, relationship is specified by the
name property on the
+ * Person Object.
+ */
@OneToMany(targetEntity = PersonDb.class, mappedBy = "name")
private List<Person> persons;
+ /**
+ * model field.
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name
+ */
@Basic
@Column(name = "additional_name", length = 255)
private String additionalName;
+ /**
+ * model field.
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name
+ */
@Basic
@Column(name = "family_name", length = 255)
private String familyName;
+ /**
+ * model field.
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name
+ */
@Basic
@Column(name = "given_name", length = 255)
private String givenName;
+ /**
+ * model field.
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name
+ */
@Basic
@Column(name = "honorific_prefix", length = 255)
private String honorificPrefix;
+ /**
+ * model field.
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name
+ */
@Basic
@Column(name = "honorific_suffix", length = 255)
private String honorificSuffix;
+ /**
+ * model field.
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name
+ */
@Basic
@Column(name = "formatted", length = 255)
private String formatted;
+ /**
+ *
+ */
public NameDb() {
}
+ /**
+ * @param formatted
+ */
public NameDb(String formatted) {
this.formatted = formatted;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name#getAdditionalName()
+ */
public String getAdditionalName() {
return additionalName;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see
org.apache.shindig.social.opensocial.model.Name#setAdditionalName(java.lang.String)
+ */
public void setAdditionalName(String additionalName) {
this.additionalName = additionalName;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name#getFamilyName()
+ */
public String getFamilyName() {
return familyName;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see
org.apache.shindig.social.opensocial.model.Name#setFamilyName(java.lang.String)
+ */
public void setFamilyName(String familyName) {
this.familyName = familyName;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name#getGivenName()
+ */
public String getGivenName() {
return givenName;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see
org.apache.shindig.social.opensocial.model.Name#setGivenName(java.lang.String)
+ */
public void setGivenName(String givenName) {
this.givenName = givenName;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name#getHonorificPrefix()
+ */
public String getHonorificPrefix() {
return honorificPrefix;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see
org.apache.shindig.social.opensocial.model.Name#setHonorificPrefix(java.lang.String)
+ */
public void setHonorificPrefix(String honorificPrefix) {
this.honorificPrefix = honorificPrefix;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see org.apache.shindig.social.opensocial.model.Name#getHonorificSuffix()
+ */
public String getHonorificSuffix() {
return honorificSuffix;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see
org.apache.shindig.social.opensocial.model.Name#setHonorificSuffix(java.lang.String)
+ */
public void setHonorificSuffix(String honorificSuffix) {
this.honorificSuffix = honorificSuffix;
}
/**
- * @return the objectId
+ * [EMAIL PROTECTED]
+ *
+ * @see org.apache.shindig.social.opensocial.jpa.DbObject#getObjectId()
*/
public long getObjectId() {
return objectId;
}
/**
+ * A list of people who have this name
+ *
* @return the persons
*/
public List<Person> getPersons() {
@@ -147,6 +249,8 @@
}
/**
+ * Set the list of people who have this name
+ *
* @param persons the persons to set
*/
public void setPersons(List<Person> persons) {
@@ -154,8 +258,8 @@
}
- /*
- * (non-Javadoc)
+ /**
+ * [EMAIL PROTECTED]
*
* @see org.apache.shindig.social.opensocial.model.Name#getFormatted()
*/
@@ -163,8 +267,8 @@
return formatted;
}
- /*
- * (non-Javadoc)
+ /**
+ * [EMAIL PROTECTED]
*
* @see
org.apache.shindig.social.opensocial.model.Name#setFormatted(java.lang.String)
*/
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationAddressDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationAddressDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationAddressDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationAddressDb.java
Wed Sep 17 04:07:09 2008
@@ -31,50 +31,91 @@
import static javax.persistence.CascadeType.REFRESH;
/**
- *
- */
-/*
* This object connects to a single Address, and to a single organization,
defining the
- * organizations relationship with the address
+ * organizations relationship with the address. The class extends AddressDb,
which stores itself in
+ * the address table. The specialization of this class is stored in
organization_address and joined
+ * on the objectId property (oid column). Records are discriminated using the
address_usage column
+ * in the address table and set to the value 'sharedaddress' (i.e. no
discrimination) indicating
+ * that the address is shared.
*/
+// TODO, uncertain about the mapping of this, oid <-> oid means one to one,
and this is only
+// associated with a single
+// Organization. IMHO, we should be mapping organizational_address.address_id
to address.oid, but
+// need to think about this.
@Entity
@Table(name = "organizational_address")
@DiscriminatorValue(value = "sharedaddress")
// this is the same as others since we want to share the data.
public class OrganizationAddressDb extends AddressDb {
+ /**
+ * Indicates this address is the primary address for the organization.
+ */
@Basic
@Column(name = "primary_organization")
private Boolean primary;
+ /**
+ * This address is associated with a single organization in this form.
+ *
+ */
@ManyToOne(targetEntity = OrganizationDb.class, cascade = { PERSIST, MERGE,
REFRESH })
@JoinColumn(name = "organization_id", referencedColumnName = "oid")
private Organization organization;
+ /**
+ * the type of the address for the organization.
+ *
+ * @see org.apache.shindig.social.opensocial.model.Address
+ */
@Basic
@Column(name = "type", length = 255)
private String type;
+ /**
+ * Create an organizational address.
+ */
public OrganizationAddressDb() {
- // TODO Auto-generated constructor stub
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see org.apache.shindig.social.opensocial.jpa.AddressDb#getType()
+ */
public String getType() {
return type;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see
org.apache.shindig.social.opensocial.jpa.AddressDb#setType(java.lang.String)
+ */
public void setType(String type) {
this.type = type;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see org.apache.shindig.social.opensocial.jpa.AddressDb#getPrimary()
+ */
public Boolean getPrimary() {
return primary;
}
+ /**
+ * [EMAIL PROTECTED]
+ *
+ * @see
org.apache.shindig.social.opensocial.jpa.AddressDb#setPrimary(java.lang.Boolean)
+ */
public void setPrimary(Boolean primary) {
this.primary = primary;
}
/**
+ * The organization this address address relates to.
+ *
* @return the organization
*/
public Organization getOrganization() {
@@ -82,6 +123,8 @@
}
/**
+ * Set the organization this address relates to.
+ *
* @param organization the organization to set
*/
public void setOrganization(Organization organization) {
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/OrganizationDb.java
Wed Sep 17 04:07:09 2008
@@ -43,6 +43,12 @@
import static javax.persistence.CascadeType.MERGE;
import static javax.persistence.CascadeType.REFRESH;
+/**
+ * An organization is stored in the organization table. There may be types of
organization where
+ * this class is extended. The storage contains a org_usage column which is
used to discriminate the
+ * usage of each organization record. Where the record is shared the value
will be shared. Classes
+ * that extend this class may have other values.
+ */
@Entity
@Table(name = "organization")
@Inheritance(strategy = InheritanceType.JOINED)
@@ -51,7 +57,13 @@
@NamedQuery(name = OrganizationDb.FINDBY_NAME,
query = "select o from OrganizationDb o where o.name = :name ")
public class OrganizationDb implements Organization, DbObject {
+ /**
+ * The name of the JPA named query to find the organization by name.
+ */
public static final String FINDBY_NAME = "q.organization.findbyname";
+ /**
+ * The name of the parameter used for the name column in JPA queries.
+ */
public static final String PARAM_NAME = "name";
/**
@@ -70,73 +82,140 @@
@Column(name = "version")
protected long version;
- @OneToOne(targetEntity = OrganizationAddressDb.class,
- mappedBy = "organization", cascade = {
+ /**
+ * The address associated with this Organization.
+ */
+ // TODO: does an organization have only one address, or many with one primary
+ @OneToOne(targetEntity = OrganizationAddressDb.class, mappedBy =
"organization", cascade = {
PERSIST, MERGE, REFRESH })
private Address address;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "description", length = 255)
private String description;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "endDate")
@Temporal(TemporalType.DATE)
private Date endDate;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "field", length = 255)
private String field;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "name", length = 255)
private String name;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "salary", length = 255)
private String salary;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "start_date")
@Temporal(TemporalType.DATE)
private Date startDate;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "sub_field", length = 255)
private String subField;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "title", length = 255)
private String title;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "webpage", length = 255)
private String webpage;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "type", length = 255)
private String type;
+ /**
+ * Part of the Organization Model
+ * @see org.apache.shindig.social.opensocial.model.Organization
+ */
@Basic
@Column(name = "primary_organization")
private Boolean primary;
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getAddress()
+ */
public Address getAddress() {
return address;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setAddress(org.apache.shindig.social.opensocial.model.Address)
+ */
public void setAddress(Address address) {
this.address = address;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#getDescription()
+ */
public String getDescription() {
return description;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setDescription(java.lang.String)
+ */
public void setDescription(String description) {
this.description = description;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getEndDate()
+ */
public Date getEndDate() {
if (endDate == null) {
return null;
@@ -144,6 +223,10 @@
return new Date(endDate.getTime());
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setEndDate(java.util.Date)
+ */
public void setEndDate(Date endDate) {
if (endDate == null) {
this.endDate = null;
@@ -152,30 +235,58 @@
}
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getField()
+ */
public String getField() {
return field;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setField(java.lang.String)
+ */
public void setField(String field) {
this.field = field;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getName()
+ */
public String getName() {
return name;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setName(java.lang.String)
+ */
public void setName(String name) {
this.name = name;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getSalary()
+ */
public String getSalary() {
return salary;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setSalary(java.lang.String)
+ */
public void setSalary(String salary) {
this.salary = salary;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#getStartDate()
+ */
public Date getStartDate() {
if (startDate == null) {
return null;
@@ -183,6 +294,10 @@
return new Date(startDate.getTime());
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setStartDate(java.util.Date)
+ */
public void setStartDate(Date startDate) {
if (startDate == null) {
this.startDate = null;
@@ -191,48 +306,89 @@
}
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getSubField()
+ */
public String getSubField() {
return subField;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setSubField(java.lang.String)
+ */
public void setSubField(String subField) {
this.subField = subField;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getTitle()
+ */
public String getTitle() {
return title;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setTitle(java.lang.String)
+ */
public void setTitle(String title) {
this.title = title;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getWebpage()
+ */
public String getWebpage() {
return webpage;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setWebpage(java.lang.String)
+ */
public void setWebpage(String webpage) {
this.webpage = webpage;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getType()
+ */
public String getType() {
return type;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setType(java.lang.String)
+ */
public void setType(String type) {
this.type = type;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.model.Organization#getPrimary()
+ */
public Boolean getPrimary() {
return primary;
}
+ /**
+ * [EMAIL PROTECTED]
+ * @see
org.apache.shindig.social.opensocial.model.Organization#setPrimary(java.lang.Boolean)
+ */
public void setPrimary(Boolean primary) {
this.primary = primary;
}
/**
- * @return the objectId
+ * [EMAIL PROTECTED]
+ * @see org.apache.shindig.social.opensocial.jpa.DbObject#getObjectId()
*/
public long getObjectId() {
return objectId;
Modified:
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/PersonAccountDb.java
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/PersonAccountDb.java?rev=696238&r1=696237&r2=696238&view=diff
==============================================================================
---
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/PersonAccountDb.java
(original)
+++
incubator/shindig/trunk/java/samples/src/main/java/org/apache/shindig/social/opensocial/jpa/PersonAccountDb.java
Wed Sep 17 04:07:09 2008
@@ -28,11 +28,10 @@
import javax.persistence.Table;
/**
- *
- */
-/*
- * This object connects to a single Address, and to a single organization,
- * defining the organizations relationship with the address
+ * This object connects to a single account to a person, defining the
relationship
+ * between the person and the account. It extends the account object, which
stored its instances in
+ * the 'account' table by storing instances of this class in the
'person_account table. Records
+ * are joined using oid, and use the same shared account discriminator.
*/
@Entity
@Table(name="person_account")
@@ -42,6 +41,9 @@
@Column(name="primary_account")
private Boolean primary;
+ /**
+ * The person connected the account
+ */
@ManyToOne(targetEntity=PersonDb.class)
@JoinColumn(name="person_id", referencedColumnName="oid")
private Person person;
@@ -52,7 +54,6 @@
public PersonAccountDb() {
- // TODO Auto-generated constructor stub
}
