Menu
▾
▴
[Cse-ip-svn-commits] SF.net SVN: cse-ip:[101] trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/ campussource/cse/cdmm
|
From: <ro...@us...> - 2009-03-24 15:02:28
|
Revision: 101
http://cse-ip.svn.sourceforge.net/cse-ip/?rev=101&view=rev
Author: roekens
Date: 2009-03-24 15:02:05 +0000 (Tue, 24 Mar 2009)
Log Message:
-----------
added javadoc
Modified Paths:
--------------
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/AttributeAdapter.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/Constants.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/DataModelManager.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/DataModelManagerBean.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/IdAdapter.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/IdNotFoundException.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/MissingAttributeException.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/MissingParameterException.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/AccountDao.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/CategoryDao.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/CourseDao.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/DAO.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/DAOJPA.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/GroupDao.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/RoleDao.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Account.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Attribute.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Category.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Course.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Entity.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/EntityContainer.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Group.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/PersistentAttribute.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Role.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/RoleType.java
trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/TransientAttribute.java
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/AttributeAdapter.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/AttributeAdapter.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/AttributeAdapter.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -6,6 +6,11 @@
import de.campussource.cse.cdmm.domain.PersistentAttribute;
import de.campussource.cse.cdmm.domain.TransientAttribute;
+/**
+ * Attribute Adapter to map transient and persistent attributes
+ * @author Sebastian Roekens
+ *
+ */
public class AttributeAdapter extends XmlAdapter<Attribute, Attribute>{
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/Constants.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/Constants.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/Constants.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -1,5 +1,11 @@
package de.campussource.cse.cdmm;
+/**
+ *
+ * Class containing all String of package to prevent multiple definitions of same Strings
+ * @author Sebastian Roekens
+ *
+ */
public class Constants{
//namespace
public static final String NAMESPACE_DATATYPES="http://cse.campussource.de/DataTypes";
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/DataModelManager.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/DataModelManager.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/DataModelManager.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -8,43 +8,145 @@
import de.campussource.cse.cdmm.domain.Group;
import de.campussource.cse.cdmm.domain.Role;
+/**
+ * Service bean for CDMM package
+ * @author Sebastian Roekens
+ *
+ */
@Remote
public interface DataModelManager {
+ /**
+ * Service method to persist category entities
+ * @param category category to persist
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage saveCategory(Category category) throws DataModelManagerException;
+ /**
+ * Service method to delete category entities
+ * @param category category to delete
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage deleteCategory(Category category) throws DataModelManagerException;
+ /**
+ * Service method to retrieve a category by id
+ * @param categoryId id of searched category
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage retrieveCategory(long categoryId) throws DataModelManagerException;
+ /**
+ * Service method to persist course entities
+ * @param course course to persist
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage saveCourse(Course course) throws DataModelManagerException;
+ /**
+ * Service method to delete course entities
+ * @param course course to delete
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage deleteCourse(Course course) throws DataModelManagerException;
+ /**
+ * Service method to retrieve a course by id
+ * @param courseId id of searched course
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage retrieveCourse(long courseId) throws DataModelManagerException;
+ /**
+ * Service method to persist role entities
+ * @param role role to persist
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage saveRole(Role role) throws DataModelManagerException;
+ /**
+ * Service method to delete role entities
+ * @param role role to delete
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage deleteRole(Role role) throws DataModelManagerException;
+ /**
+ * Service method to retrieve an role entity by id
+ * @param roleId id of searched role entity
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage retrieveRole(long roleId) throws DataModelManagerException;
+ /**
+ * Service method to retrieve an role entity by account and course
+ * @param accountId id of account reference of role
+ * @param courseId id of course reference of role
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage retrieveRole(long accountId, long courseId) throws DataModelManagerException;
+ /**
+ * Service method to persist account entities
+ * @param account account to persist
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage saveAccount(Account account) throws DataModelManagerException;
+ /**
+ * Service method to delete account entities
+ * @param account account to delete
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage deleteAccount(Account account) throws DataModelManagerException;
+ /**
+ * Service method to retrieve account entities by id
+ * @param accountId id of searched account entity
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage retrieveAccount(long accountId) throws DataModelManagerException;
+ /**
+ * Service method to retrieve Group entities by id
+ * @param groupId id of searched group entity
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage retrieveGroup(long groupId) throws DataModelManagerException;
+ /**
+ * Service method to persist Group entities
+ * @param group group to persist
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage saveGroup(Group group) throws DataModelManagerException;
+ /**
+ * Service method to delete group entities
+ * @param group group to delete
+ * @return
+ * @throws DataModelManagerException
+ */
public CSEMessage deleteGroup(Group group) throws DataModelManagerException;
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/DataModelManagerBean.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/DataModelManagerBean.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/DataModelManagerBean.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -14,6 +14,11 @@
import de.campussource.cse.cdmm.domain.Group;
import de.campussource.cse.cdmm.domain.Role;
+/**
+ * Service bean for CDMM package
+ * @author Sebastian Roekens
+ *
+ */
@Stateless
public class DataModelManagerBean implements DataModelManager {
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/IdAdapter.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/IdAdapter.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/IdAdapter.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -2,6 +2,11 @@
import javax.xml.bind.annotation.adapters.XmlAdapter;
+/**
+ * Adapter class to convert ids from String to Long and back
+ * @author Sebastian Roekens
+ *
+ */
public class IdAdapter extends XmlAdapter<String, Long>{
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/IdNotFoundException.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/IdNotFoundException.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/IdNotFoundException.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -1,7 +1,8 @@
package de.campussource.cse.cdmm;
/**
- *
+ * Exception to represent failed searches for objects
+ * e.g. no objetc with given id existing
* @author Sebastian Roekens
*/
public class IdNotFoundException extends DataModelManagerException {
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/MissingAttributeException.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/MissingAttributeException.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/MissingAttributeException.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -1,7 +1,7 @@
package de.campussource.cse.cdmm;
/**
- *
+ * Exception to represent missing attributes in objects which shall be persisted
* @author Sebastian Roekens
*/
public class MissingAttributeException extends DataModelManagerException {
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/MissingParameterException.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/MissingParameterException.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/MissingParameterException.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -1,7 +1,7 @@
package de.campussource.cse.cdmm;
/**
- *
+ * Exception to represent missing parameters in method calls
* @author Sebastian Roekens
*/
public class MissingParameterException extends DataModelManagerException {
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/AccountDao.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/AccountDao.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/AccountDao.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -2,6 +2,11 @@
import de.campussource.cse.cdmm.domain.Account;
+/**
+ * DAO Class for Account entity
+ * @author Sebastian Roekens
+ *
+ */
public class AccountDao extends DAOJPA<Account> {
}
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/CategoryDao.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/CategoryDao.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/CategoryDao.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -2,6 +2,11 @@
import de.campussource.cse.cdmm.domain.Category;
+/**
+ * DAO Class for Category entity
+ * @author Sebastian Roekens
+ *
+ */
public class CategoryDao extends DAOJPA<Category>{
}
\ No newline at end of file
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/CourseDao.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/CourseDao.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/CourseDao.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -2,6 +2,11 @@
import de.campussource.cse.cdmm.domain.Course;
+/**
+ * DAO Class for Course entity
+ * @author Sebastian Roekens
+ *
+ */
public class CourseDao extends DAOJPA<Course> {
}
\ No newline at end of file
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/DAO.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/DAO.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/DAO.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -4,12 +4,33 @@
import de.campussource.cse.cdmm.DataModelManagerException;
+/**
+ * @author Ingo D\xFCppe
+ * Interface for DAO Classes of entities
+ * @param <T>
+ */
public interface DAO<T> {
+ /**
+ * Finder method to find persisted entities by id
+ * @param id id of searched object
+ * @return entity object with given id
+ * @throws DataModelManagerException
+ */
public T find(Serializable id) throws DataModelManagerException;
+ /**
+ * DAO method to persist given object
+ * @param entity object to persist
+ * @throws DataModelManagerException
+ */
public void persist(T entity) throws DataModelManagerException;
+ /**
+ * DAO method to delete entity objects
+ * @param entity object to delete
+ * @throws DataModelManagerException
+ */
public void remove(T entity) throws DataModelManagerException;
}
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/DAOJPA.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/DAOJPA.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/DAOJPA.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -13,6 +13,12 @@
import de.campussource.cse.cdmm.MissingParameterException;
+/**
+ * Abstract DAO class for entities
+ * @author Ingo D\xFCppe
+ *
+ * @param <E> Entity type of DAO class
+ */
public abstract class DAOJPA<E> implements DAO<E> {
@PersistenceContext
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/GroupDao.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/GroupDao.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/GroupDao.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -2,6 +2,11 @@
import de.campussource.cse.cdmm.domain.Group;
+/**
+ * DAO Class for Group entity
+ * @author Sebastian Roekens
+ *
+ */
public class GroupDao extends DAOJPA<Group> {
}
\ No newline at end of file
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/RoleDao.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/RoleDao.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/dao/RoleDao.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -10,6 +10,11 @@
import de.campussource.cse.cdmm.MissingParameterException;
import de.campussource.cse.cdmm.domain.Role;
+/**
+ * DAO Class for Role entity
+ * @author Sebastian Roekens
+ *
+ */
public class RoleDao extends DAOJPA<Role> {
@Override
@@ -38,6 +43,13 @@
super.remove(role);
}
+ /**
+ * Search method to find a role with given course and account reference
+ * @param accountId id of account reference of searched role
+ * @param courseId id of course reference of searched role
+ * @return role object with given account and course reference
+ * @throws DataModelManagerException Exception is thrown, when no role with given accountId and courseId exists
+ */
public Role retrieveRole(long accountId, long courseId) throws DataModelManagerException{
if (accountId == 0){
throw new MissingParameterException("Paramter accountId is mandatory!");
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Account.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Account.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Account.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -18,8 +18,16 @@
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
+import org.apache.commons.lang.builder.ToStringBuilder;
+import org.apache.commons.lang.builder.ToStringStyle;
+
import de.campussource.cse.cdmm.Constants;
+/**
+ * Account entity object
+ * @author Sebastian Roekens
+ *
+ */
@Entity(name=Constants.ACCOUNT)
@Table(name = Constants.TABLENAME_ACCOUNT)
@Inheritance(strategy=InheritanceType.JOINED)
@@ -44,6 +52,11 @@
setId(id);
}
+ /**
+ * Convenience method to add an account to a group
+ * @param group group account should be added to
+ * @return success of operation
+ */
public boolean addToGroup(Group group){
if(group==null){
return false;
@@ -66,6 +79,11 @@
return true;
}
+ /**
+ * Convenience method to remove an account from a group
+ * @param group group to remove account from
+ * @return success of operation
+ */
public boolean removeFromGroup(Group group){
if (group == null){
return false;
@@ -82,6 +100,11 @@
return true;
}
+ /**
+ * Convenience method to check if account is member of a group
+ * @param group group to check membership of
+ * @return membership state of account and given group
+ */
public boolean isInGroup(Group group){
if (group == null){
return false;
@@ -92,6 +115,34 @@
return (group.getMembers().contains(this));
}
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (!(obj instanceof Account)) {
+ return false;
+ }
+ if (this.getId() == null) {
+ return false;
+ } else {
+ return this.getId().equals(((Account) obj).getId());
+ }
+ }
+
+ @Override
+ public int hashCode() {
+ if (this.getId() == null) {
+ return super.hashCode();
+ } else {
+ return this.getId().hashCode();
+ }
+ }
+
+ public String toString() {
+ return new ToStringBuilder(this, ToStringStyle.DEFAULT_STYLE).append(this.getId()).toString();
+ }
+
@XmlElementWrapper(name=Constants.ROLES)
@XmlElement(name=Constants.ROLE)
public List<Role> getRoles() {
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Attribute.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Attribute.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Attribute.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -10,6 +10,11 @@
import de.campussource.cse.cdmm.AttributeAdapter;
import de.campussource.cse.cdmm.Constants;
+/**
+ * Attribute entity object
+ * @author Sebastian Roekens
+ *
+ */
@XmlRootElement(namespace=Constants.NAMESPACE_DATATYPES)
@XmlType(namespace=Constants.NAMESPACE_DATATYPES)
@XmlJavaTypeAdapter(value=AttributeAdapter.class)
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Category.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Category.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Category.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -21,6 +21,11 @@
import de.campussource.cse.cdmm.Constants;
+/**
+ * Category entity object
+ * @author Sebastian Roekens
+ *
+ */
@Entity(name=Constants.CATEGORY)
@Inheritance(strategy=InheritanceType.JOINED)
@Table(name = Constants.TABLENAME_CATEGORY)
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Course.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Course.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Course.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -24,6 +24,11 @@
import de.campussource.cse.cdmm.Constants;
+/**
+ * Course entity object
+ * @author Sebastian Roekens
+ *
+ */
@Entity(name=Constants.COURSE)
@Table(name = Constants.TABLENAME_COURSE)
@Inheritance(strategy=InheritanceType.JOINED)
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Entity.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Entity.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Entity.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -24,6 +24,11 @@
import de.campussource.cse.cdmm.Constants;
import de.campussource.cse.cdmm.IdAdapter;
+/**
+ * Entity object - super class of other entity types
+ * @author Sebastian Roekens
+ *
+ */
@javax.persistence.Entity(name=Constants.ENTITY)
@Table(name = Constants.TABLENAME_ENTITY)
@Inheritance(strategy=InheritanceType.JOINED)
@@ -45,6 +50,7 @@
this.id = id;
}
+ @Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
@@ -59,6 +65,7 @@
}
}
+ @Override
public int hashCode() {
if (this.id == null) {
return super.hashCode();
@@ -67,6 +74,7 @@
}
}
+ @Override
public String toString() {
return new ToStringBuilder(this, ToStringStyle.DEFAULT_STYLE).append(id).toString();
}
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/EntityContainer.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/EntityContainer.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/EntityContainer.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -14,6 +14,11 @@
import de.campussource.cse.cdmm.Constants;
+/**
+ * Container class for entity objects
+ * @author Sebastian Roekens
+ *
+ */
@XmlRootElement(namespace=Constants.NAMESPACE_DATATYPES)
@XmlType(namespace=Constants.NAMESPACE_DATATYPES)
public class EntityContainer{
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Group.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Group.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Group.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -19,6 +19,11 @@
import de.campussource.cse.cdmm.Constants;
+/**
+ * Group entity object
+ * @author Sebastian Roekens
+ *
+ */
@Entity(name=Constants.GROUP)
@Table(name = Constants.TABLENAME_GROUP)
@Inheritance(strategy=InheritanceType.JOINED)
@@ -36,7 +41,8 @@
setId(id);
}
- public boolean equals(Object obj) {
+ @Override
+ public boolean equals(Object obj) {
if (this == obj) {
return true;
}
@@ -50,6 +56,7 @@
}
}
+ @Override
public int hashCode() {
if (this.getId() == null) {
return super.hashCode();
@@ -58,6 +65,7 @@
}
}
+ @Override
public String toString() {
return new ToStringBuilder(this, ToStringStyle.DEFAULT_STYLE).append(this.getId()).toString();
}
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/PersistentAttribute.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/PersistentAttribute.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/PersistentAttribute.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -6,6 +6,11 @@
import de.campussource.cse.cdmm.Constants;
+/**
+ * Representation of an persistent attribute
+ * @author Sebastian Roekens
+ *
+ */
@XmlTransient
public class PersistentAttribute extends Attribute {
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Role.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Role.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/Role.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -22,6 +22,11 @@
import de.campussource.cse.cdmm.Constants;
+/**
+ * Role entity object
+ * @author Sebastian Roekens
+ *
+ */
@Entity(name=Constants.ROLE)
@Table(name = Constants.TABLENAME_ROLE)
@Inheritance(strategy=InheritanceType.JOINED)
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/RoleType.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/RoleType.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/RoleType.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -6,6 +6,15 @@
import de.campussource.cse.cdmm.Constants;
+/**
+ * Role Type to differentiate 3 types of roles:
+ * UNDEFINED - if role type cannot be defined
+ * PARTICIPANT - if account participates in a course
+ * ASSISTANT - if account is an assistant in a course
+ *
+ * @author Sebastian Roekens
+ *
+ */
@XmlEnum
@XmlType(namespace=Constants.NAMESPACE_DATATYPES)
public enum RoleType{
Modified: trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/TransientAttribute.java
===================================================================
--- trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/TransientAttribute.java 2009-03-24 14:21:24 UTC (rev 100)
+++ trunk/sandbox/cse-ip/sc-cdmm/src/main/java/de/campussource/cse/cdmm/domain/TransientAttribute.java 2009-03-24 15:02:05 UTC (rev 101)
@@ -2,6 +2,11 @@
import javax.xml.bind.annotation.XmlTransient;
+/**
+ * Representation of an attribute object, which should not be saved persistent
+ * @author Sebastian Roekens
+ *
+ */
@XmlTransient
public class TransientAttribute extends Attribute {
public TransientAttribute(){}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
