dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #00668
[Branch ~dhis2-devs-core/dhis2/trunk] Rev 184: Work in progress on Javadoc
------------------------------------------------------------
revno: 184
committer: Lars Helge Oeverland larshelge@xxxxxxxxx
branch nick: trunk
timestamp: Thu 2009-04-16 16:56:01 +0200
message:
Work in progress on Javadoc
modified:
dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/CompleteDataSetRegistrationService.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/CompleteDataSetRegistrationStore.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/SectionService.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/SectionStore.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/document/DocumentService.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/document/DocumentStore.java
dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/reporttable/jdbc/ReportTableManager.java
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/CompleteDataSetRegistrationService.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/CompleteDataSetRegistrationService.java 2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/CompleteDataSetRegistrationService.java 2009-04-16 14:56:01 +0000
@@ -41,20 +41,79 @@
{
String ID = CompleteDataSetRegistrationService.class.getName();
+ /**
+ * Saves a CompleteDataSetRegistration.
+ *
+ * @param registration the CompleteDataSetRegistration to save.
+ */
void saveCompleteDataSetRegistration( CompleteDataSetRegistration registration );
+ /**
+ * Retrieves the CompleteDataSetRegistration for the given DataSet, Period
+ * and Source.
+ *
+ * @param dataSet the DataSet.
+ * @param period the Period.
+ * @param source the Source.
+ * @return the CompleteDataSetRegistration.
+ */
CompleteDataSetRegistration getCompleteDataSetRegistration( DataSet dataSet, Period period, Source source );
+ /**
+ * Deletes a CompleteDataSetRegistration.
+ *
+ * @param registration the CompleteDataSetRegistration to delete.
+ */
void deleteCompleteDataSetRegistration( CompleteDataSetRegistration registration );
+ /**
+ * Retrieves all CompleteDataSetRegistrations.
+ *
+ * @return a Collection of CompleteDataSetRegistrations.
+ */
Collection<CompleteDataSetRegistration> getAllCompleteDataSetRegistrations();
+ /**
+ * Retrieves the CompleteDataSetRegistrations for the given Collections of
+ * DataSets, Sources and Periods.
+ *
+ * @param dataSets the Collection of DataSets.
+ * @param sources the Collection of Sources.
+ * @param periods the Collection of Periods.
+ * @return a Collection of CompleteDataSetRegistrations.
+ */
Collection<CompleteDataSetRegistration> getCompleteDataSetRegistrations(
Collection<DataSet> dataSets, Collection<? extends Source> sources, Collection<Period> periods );
+ /**
+ * Retrieves the number of existing CompleteDataSetRegistration for the given
+ * DataSet, Collection of Sources and Period.
+ *
+ * @param dataSet the DataSet.
+ * @param sources the Collection of Sources.
+ * @param period the Period.
+ * @return the number of existing CompleteDataSetRegistrations.
+ */
int getCompleteDataSetRegistrationsForDataSet( DataSet dataSet, Collection<? extends Source> sources, Period period );
-
+
+ /**
+ * Retrieves the number of existing CompleteDataSetRegistration for the given
+ * DataSet, Collection of Sources, Period and Date. The Date deadline is the
+ * date that the registration must be made before in order to be defined as
+ * "on time".
+ *
+ * @param dataSet the DataSet.
+ * @param sources the Collection of Sources.
+ * @param period the Period.
+ * @param deadline the dead line.
+ * @return the number of existing CompleteDataSetRegistrations.
+ */
int getCompleteDataSetRegistrationsForDataSet( DataSet dataSet, Collection<? extends Source> sources, Period period, Date deadline );
+ /**
+ * Deletes the CompleteDataSetRegistrations associated with the given DataSet.
+ *
+ * @param dataSet the DataSet.
+ */
void deleteCompleteDataSetRegistrations( DataSet dataSet );
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/CompleteDataSetRegistrationStore.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/CompleteDataSetRegistrationStore.java 2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/CompleteDataSetRegistrationStore.java 2009-04-16 14:56:01 +0000
@@ -40,23 +40,81 @@
public interface CompleteDataSetRegistrationStore
{
String ID = CompleteDataSetRegistrationStore.class.getName();
-
+
+ /**
+ * Saves a CompleteDataSetRegistration.
+ *
+ * @param registration the CompleteDataSetRegistration to save.
+ */
void saveCompleteDataSetRegistration( CompleteDataSetRegistration registration );
-
+
+ /**
+ * Retrieves the CompleteDataSetRegistration for the given DataSet, Period
+ * and Source.
+ *
+ * @param dataSet the DataSet.
+ * @param period the Period.
+ * @param source the Source.
+ * @return the CompleteDataSetRegistration.
+ */
CompleteDataSetRegistration getCompleteDataSetRegistration( DataSet dataSet, Period period, Source source );
-
+
+ /**
+ * Deletes a CompleteDataSetRegistration.
+ *
+ * @param registration the CompleteDataSetRegistration to delete.
+ */
void deleteCompleteDataSetRegistration( CompleteDataSetRegistration registration );
-
+
+ /**
+ * Retrieves a Collection of CompleteDataSetRegistration for the given DataSet,
+ * Collection of Sources and Period.
+ *
+ * @param dataSet the DataSet.
+ * @param sources the Collection of Sources.
+ * @param period the Period.
+ * @return the number of existing CompleteDataSetRegistrations.
+ */
Collection<CompleteDataSetRegistration> getCompleteDataSetRegistrations(
DataSet dataSet, Collection<? extends Source> sources, Period period );
+ /**
+ * Retrieves all CompleteDataSetRegistration.
+ *
+ * @return a Collection of CompleteDataSetRegistrations.
+ */
Collection<CompleteDataSetRegistration> getAllCompleteDataSetRegistrations();
+ /**
+ * Retrieves a Collection of CompleteDataSetRegistrations for the given Collection
+ * of DataSets, Sources and Periods.
+ *
+ * @param dataSets the Collection of DataSets.
+ * @param sources the Collection of Sources.
+ * @param periods the Collection of Periods.
+ * @return a Collection of CompleteDataSetRegistrations.
+ */
Collection<CompleteDataSetRegistration> getCompleteDataSetRegistrations(
Collection<DataSet> dataSets, Collection<? extends Source> sources, Collection<Period> periods );
+ /**
+ * Retrieves a Collection of CompleteDataSetRegistrations for the given DataSet,
+ * Collection of Sources, Period and Date. The Date deadline is the date that
+ * the registration must be made before in order to be defined as "on time".
+ *
+ * @param dataSet the DataSet.
+ * @param sources the Collection of Sources.
+ * @param period the Period.
+ * @param deadline the Date.
+ * @return a Collection of CompleteDataSetRegistrations.
+ */
Collection<CompleteDataSetRegistration> getCompleteDataSetRegistrations(
DataSet dataSet, Collection<? extends Source> sources, Period period, Date deadline );
-
+
+ /**
+ * Deletes the CompleteDataSetRegistrations associated with the given DataSet.
+ *
+ * @param dataSet the DataSet.
+ */
void deleteCompleteDataSetRegistrations( DataSet dataSet );
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/SectionService.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/SectionService.java 2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/SectionService.java 2009-04-16 14:56:01 +0000
@@ -33,17 +33,56 @@
{
String ID = SectionService.class.getName();
+ /**
+ * Adds a Section.
+ *
+ * @param section the Section to add.
+ * @return the generated identifier.
+ */
int addSection( Section section );
+ /**
+ * Updates a Section.
+ *
+ * @param section the Section to update.
+ */
void updateSection( Section section );
+ /**
+ * Deletes a Section.
+ *
+ * @param section the Section to delete.
+ */
void deleteSection( Section section );
+ /**
+ * Retrieves the Section with the given identifier.
+ *
+ * @param id the identifier of the Section to retrieve.
+ * @return the Section.
+ */
Section getSection( int id );
+ /**
+ * Retrieves the Section with the given name.
+ *
+ * @param name the name of the Section to retrieve.
+ * @return the Section.
+ */
Section getSectionByName( String name );
+ /**
+ * Retrieves all Sections.
+ *
+ * @return a Collection of Sections.
+ */
Collection<Section> getAllSections();
- Collection<Section> getSectionByDataSet(DataSet dataSet);
+ /**
+ * Retrieves all Sections for the given DataSet.
+ *
+ * @param dataSet the DataSet.
+ * @return a Collection of Sections.
+ */
+ Collection<Section> getSectionByDataSet( DataSet dataSet );
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/SectionStore.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/SectionStore.java 2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/dataset/SectionStore.java 2009-04-16 14:56:01 +0000
@@ -32,18 +32,57 @@
public interface SectionStore
{
String ID = SectionStore.class.getName();
-
+
+ /**
+ * Adds a Section.
+ *
+ * @param section the Section to add.
+ * @return the generated identifier.
+ */
int addSection( Section section );
+ /**
+ * Updates a Section.
+ *
+ * @param section the Section to update.
+ */
void updateSection( Section section );
+ /**
+ * Deletes a Section.
+ *
+ * @param section the Section to delete.
+ */
void deleteSection( Section section );
-
+
+ /**
+ * Retrieves the Section with the given identifier.
+ *
+ * @param id the identifier of the Section to retrieve.
+ * @return the Section.
+ */
Section getSection( int id );
+ /**
+ * Retrieves the Section with the given name.
+ *
+ * @param name the name of the Section to retrieve.
+ * @return the Section.
+ */
Section getSectionByName( String name );
-
+
+ /**
+ * Retrieves all Sections.
+ *
+ * @return a Collection of Sections.
+ */
Collection<Section> getAllSections();
-
+
+ /**
+ * Retrieves all Sections for the given DataSet.
+ *
+ * @param dataSet the DataSet.
+ * @return a Collection of Sections.
+ */
Collection<Section> getSectionByDataSet(DataSet dataSet);
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/document/DocumentService.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/document/DocumentService.java 2009-03-08 06:36:12 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/document/DocumentService.java 2009-04-16 14:56:01 +0000
@@ -38,13 +38,41 @@
String ID = DocumentService.class.getName();
String DIR = "documents";
+ /**
+ * Saves a Document.
+ *
+ * @param document the Document to save.
+ * @return the generated identifier.
+ */
int saveDocument( Document document );
+ /**
+ * Retrieves the Document with the given identifier.
+ *
+ * @param id the identifier of the Document.
+ * @return the Document.
+ */
Document getDocument( int id );
+ /**
+ * Deletes a Document.
+ *
+ * @param document the Document to delete.
+ */
void deleteDocument( Document document );
-
+
+ /**
+ * Retrieves all Documents.
+ *
+ * @return a Collection of Documents.
+ */
Collection<Document> getAllDocuments();
+ /**
+ * Retrieves the Document with the given name.
+ *
+ * @param name the name of the Document.
+ * @return the Document.
+ */
Document getDocumentByName( String name );
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/document/DocumentStore.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/document/DocumentStore.java 2009-03-08 06:36:12 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/document/DocumentStore.java 2009-04-16 14:56:01 +0000
@@ -36,14 +36,42 @@
public interface DocumentStore
{
String ID = DocumentStore.class.getName();
-
+
+ /**
+ * Saves a Document.
+ *
+ * @param document the Document to save.
+ * @return the generated identifier.
+ */
int saveDocument( Document document );
-
+
+ /**
+ * Retrieves the Document with the given identifier.
+ *
+ * @param id the identifier of the Document.
+ * @return the Document.
+ */
Document getDocument( int id );
-
+
+ /**
+ * Deletes a Document.
+ *
+ * @param document the Document to delete.
+ */
void deleteDocument( Document document );
-
+
+ /**
+ * Retrieves all Documents.
+ *
+ * @return a Collection of Documents.
+ */
Collection<Document> getAllDocuments();
-
+
+ /**
+ * Retrieves the Document with the given name.
+ *
+ * @param name the name of the Document.
+ * @return the Document.
+ */
Document getDocumentByName( String name );
}
=== modified file 'dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/reporttable/jdbc/ReportTableManager.java'
--- dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/reporttable/jdbc/ReportTableManager.java 2009-03-08 11:53:40 +0000
+++ dhis-2/dhis-services/dhis-service-reporting/src/main/java/org/hisp/dhis/reporttable/jdbc/ReportTableManager.java 2009-04-16 14:56:01 +0000
@@ -51,10 +51,31 @@
*/
void createReportTable( ReportTable reportTable );
+ /**
+ * Deletes a ReportTable.
+ *
+ * @param reportTable the ReportTable to delete.
+ */
void removeReportTable( ReportTable reportTable );
+ /**
+ * Returns an AggregatedValueMap.
+ *
+ * @param reportTable the ReportTable.
+ * @param indicator the Indicator.
+ * @param categoryOptionCombo the DataElementCategoryOptionCombo.
+ * @param period the Period.
+ * @param unit the OrganisationUnit.
+ * @return a Map with String as keys and Double as values.
+ */
Map<String, Double> getAggregatedValueMap( ReportTable reportTable, MetaObject indicator,
DataElementCategoryOptionCombo categoryOptionCombo, Period period, OrganisationUnit unit );
+ /**
+ * Returns a ReportTableData object for the given ReportTable.
+ *
+ * @param reportTable the ReportTable.
+ * @return a ReportTableData object.
+ */
ReportTableData getReportTable( ReportTable reportTable );
}
--
Trunk
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk
Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription.
