WebSVN – SmartDukaan – Diff – /trunk/webapp/src/in/shop2020/metamodel/definitions/DefinitionsContainer.java

 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 /**
+ * Single point of access to all definition objects
+ *
  * @author naveen
+ *
  */
 public class DefinitionsContainer implements Serializable {
 	/**
+	 *
 	 */
 	private static final long serialVersionUID = 1L;
+	/**
+	 * Hashtable of Category ID to Category object
+	 */
 	private Map<Long, Category> categories;
+	/**
+	 * Hashtable of Slide ID to SlideDefinition object
+	 */
 	private Map<Long, SlideDefinition> slideDefinitions;
+	/**
+	 * Hashtable of Feature Definition ID to FeatureDefinition object
+	 */
 	private Map<Long, FeatureDefinition> featureDefinitions;
+	/**
+	 * Hashtable of Datatype Definition ID to DatatypeDefinition object
+	 */
 	private Map<Long, DatatypeDefinition> datatypeDefinitions;
+	/**
+	 * Hashtable of Enum value ID to EnumValue object
+	 */
 	private Map<Long, EnumValue> enumValues;
+	/**
+	 * Hashtable of Unit ID to Unit object
+	 */
 	private Map<Long, Unit> units;
 	/**
-	 *
+	 * Empty constructor. Data structures are initialised as needed
 	 */
 	public DefinitionsContainer() {
 		// Lazy initialization
+	}
 	/**
+	 * Returns all Unit objects in the database
+	 *
+	 * @return Map Null if units are not imported into definitions db
+	 * (serialized java objects)
+	 *
-	 * @return Map
 	 * @throws Exception
 	 */
 	@SuppressWarnings("unchecked")
 	public Map<Long, Unit> getUnits() throws Exception {
 		// De-serialize
 		return this.units;
+	}
 	/**
+	 * Resolves Unit ID into Unit object
+	 *
-	 * @param unitID
+	 * @param unitID Unit ID
 	 * @return Unit
 	 * @throws Exception
 	 */
 	public Unit getUnit(long unitID) throws Exception {
 		// Initialize
 		return this.units.get(new Long(unitID));
+	}
 	/**
-	 * @return the datatypeDefinitions
+	 * Returns all DatatypeDefintion object in database
+	 *
+	 * @return the datatypeDefinitions List of DatatypeDefinition objects
 	 * @throws Exception
 	 */
 	@SuppressWarnings("unchecked")
 	public Map<Long, DatatypeDefinition> getDatatypeDefinitions()
 		throws Exception {
+		}
 		return this.datatypeDefinitions;
+	}
 	/**
+	 * Resolves Datatype Definition ID into DatetypeDefinition object
+	 *
-	 * @param unitID
+	 * @param unitID Unit ID
 	 * @return Unit
 	 * @throws Exception
 	 */
 	public DatatypeDefinition getDatatypeDefinition(long id) throws Exception {
 		return this.datatypeDefinitions.get(new Long(id));
+	}
 	/**
+	 * Returns EnumValue ID for datatype definition ID and enum value string
+	 * to match. Match is case insensitive
+	 *
-	 * @param datatypeDefID
+	 * @param datatypeDefID DatatypeDefinition ID
-	 * @param value
+	 * @param value query enum value string
 	 * @return long enumValueID - "-1" if not found
 	 * @throws Exception
 	 */
 	public long getEnumValueID(long datatypeDefID, String value)
 		throws Exception {
 		return enumValueID;
+	}
 	/**
+	 * Returns all category objects in the database
+	 *
 	 * @return the categories
 	 * @throws Exception
 	 */
 	@SuppressWarnings("unchecked")
 	public Map<Long, Category> getCategories() throws Exception {
+		}
 		return this.categories;
+	}
 	/**
+	 * Resolves Category ID into Category object
+	 *
-	 * @param categoryID
+	 * @param categoryID Category ID
 	 * @return Category
 	 * @throws Exception
 	 */
 	public Category getCategory(long categoryID) throws Exception {
 		return this.categories.get(new Long(categoryID));
+	}
 	/**
+	 * Returns expanded Category object. All numeric identifiers are resolved
+	 * into detailed objects
+	 *
 	 * @param categoryID
 	 * @return ExpandedCategory
 	 * @throws Exception
 	 */
 		return expCategory;
+	}
 	/**
+	 * Returns all children categories for a Category ID
+	 *
 	 * @param categoryID
-	 * @return List<Category>
+	 * @return List<Category> Children Categories
 	 * @throws Exception
 	 */
 	public List<Category> getChildrenCategories(long categoryID)
 		throws Exception {
 			this.getCategories();
+		}
 		return this.categories.get(new Long(categoryID)).getChildrenCategory();
+	}
 	/**
+	 * Returns all CategorySlideDefinition objects for a Category ID
+	 *
-	 * @param categoryID
+	 * @param categoryID Category ID
 	 * @return List<CategorySlideDefinition>
 	 * @throws Exception
 	 */
 	public List<CategorySlideDefinition> getCategorySlideDefinitions(
 			long categoryID) throws Exception {
 		return category.getCategorySlideDefintions();
+	}
 	/**
+	 * Returns All SlideDefinition objects in database
+	 *
 	 * @return the slideDefinitions
 	 * @throws Exception
 	 */
 	@SuppressWarnings("unchecked")
 	public Map<Long, SlideDefinition> getSlideDefinitions() throws Exception {
+		}
 		return this.slideDefinitions;
+	}
 	/**
+	 * Resolves SlideDefinition ID into SlideDefinition object
+	 *
 	 * @param id
 	 * @return SlideDefinition
 	 * @throws Exception
 	 */
 		return this.slideDefinitions.get(new Long(id));
+	}
 	/**
+	 * Returns SlideDefinition objects for a category and matching slide label
+	 *
 	 * @param label
 	 * @return List<SlideDefinition>
 	 * @throws Exception
 	 */
 		return matchingSlides;
+	}
 	/**
+	 * Resolves Category ID into Category object
+	 *
 	 * @param categoryID
-	 * @return
+	 * @return List<SlideDefinition>
 	 * @throws Exception
 	 */
 	public List<SlideDefinition> getSlideDefinitions(long categoryID)
 		throws Exception {
 			matchingSlides.add(sDef);
+		}
 		return matchingSlides;
+	}
 	/**
+	 * Returns list of SlideDefinition objects for a category and editorial
+	 * importance value
+	 *
 	 * @param categoryID
 	 * @param EditorialImportance imp
 	 * @return List<SlideDefinition>
 	 * @throws Exception
+		}
 		return slideDefs;
+	}
 	/**
+	 * Returns all FeatureDefinition object in database
+	 *
 	 * @return Map<Long, FeatureDefinition>
 	 * @throws Exception
 	 */
 	@SuppressWarnings("unchecked")
+		}
 		return this.featureDefinitions;
+	}
 	/**
+	 * Returns all FeatureDefinition objects for a slide
+	 *
 	 * @param slideID
 	 * @return List<FeatureDefinition>
 	 * @throws Exception
 	 */
 		return featureDefs;
+	}
 	/**
+	 * Returns list of FeatureDefinition objects for a slide given editorial
+	 * importance
+	 *
 	 * @param slideID
-	 * @param imp
+	 * @param imp Editorial Importance enum object
 	 * @return List<FeatureDefinition>
 	 * @throws Exception
 	 */
 	public List<FeatureDefinition> getFeatureDefinitions(long slideID,
 			EditorialImportance imp)  throws Exception {
 		return featureDefs;
+	}
 	/**
+	 * Resolves Feature Definition ID into FeatureDefinition object
+	 *
-	 * @param id
+	 * @param id Feature Definition ID
 	 * @return FeatureDefinition
 	 * @throws Exception
 	 */
 	public FeatureDefinition getFeatureDefinition(long id) throws Exception {
 		return this.featureDefinitions.get(new Long(id));
+	}
 	/**
+	 * Returns matching FeatureDefinition object for slide ID and feature label.
+	 * Label matching is case insensitive.
+	 *
-	 * @param slideID
+	 * @param slideID Slide ID
-	 * @param featureLabel
+	 * @param featureLabel label to match, case is ignored
 	 * @return FeatureDefinition
 	 * @throws Exception
 	 */
 	public FeatureDefinition getFeatureDefinition(long slideID,
 			String featureLabel) throws Exception {
 		return featureDef;
+	}
 	/**
+	 * Returns all EnumValue objects in the database
+	 *
 	 * @return the enumValues
 	 * @throws Exception
 	 */
 	@SuppressWarnings("unchecked")
 	public Map<Long, EnumValue> getEnumValues() throws Exception {
 		return this.enumValues;
+	}
 	/**
+	 * Resolves Enum value ID into EnumValue object
+	 *
 	 * @param enumValueID
 	 * @return EnumValue
 	 * @throws Exception
 	 */

Subversion Repositories SmartDukaan

(root)/trunk/webapp/src/in/shop2020/metamodel/definitions/DefinitionsContainer.java @ 49 – Rev 45 → 49