From 6abdc3a78eeaf439615eb22a3fb9ae735c198662 Mon Sep 17 00:00:00 2001
From: cdtank <cdtank@43c2fc9b-1942-4403-87b2-35b4218f7473>
Date: Tue, 25 Jan 2011 18:29:54 +0000
Subject: [PATCH] 1. Changes the logic for language to be displayed along with
 different sparklines in different cases. co-authorship & co-investigatorship
 is done.

---
 .../coAuthorshipSparklineContent.ftl          | 102 +++++++++++++----
 .../copi/coInvestigationSparklineContent.ftl  | 108 ++++++++++++++----
 2 files changed, 163 insertions(+), 47 deletions(-)

diff --git a/productMods/templates/freemarker/visualization/coauthorship/coAuthorshipSparklineContent.ftl b/productMods/templates/freemarker/visualization/coauthorship/coAuthorshipSparklineContent.ftl
index a28c9406..170c739b 100644
--- a/productMods/templates/freemarker/visualization/coauthorship/coAuthorshipSparklineContent.ftl
+++ b/productMods/templates/freemarker/visualization/coauthorship/coAuthorshipSparklineContent.ftl
@@ -17,15 +17,21 @@
         <script type="text/javascript">
         
             function drawCoauthorsSparklineVisualization(providedSparklineImgTD) {
+            
+                var unknownYearPublicationCounts = ${sparklineVO.unknownYearPublications};
+                var onlyUnknownYearPublications = false;
     
                 var data = new google.visualization.DataTable();
                 data.addColumn('string', 'Year');
                 data.addColumn('number', 'Unique co-authors');
                 data.addRows(${sparklineVO.yearToEntityCountDataTable?size});
                 
+                var knownYearPublicationCounts = 0;
+                
                 <#list sparklineVO.yearToEntityCountDataTable as yearToUniqueCoauthorsDataElement>                        
                     data.setValue(${yearToUniqueCoauthorsDataElement.yearToEntityCounter}, 0, '${yearToUniqueCoauthorsDataElement.year}');
                     data.setValue(${yearToUniqueCoauthorsDataElement.yearToEntityCounter}, 1, ${yearToUniqueCoauthorsDataElement.currentEntitiesCount});
+                    knownYearPublicationCounts += ${yearToUniqueCoauthorsDataElement.currentEntitiesCount};
                 </#list>
                 
                 <#-- Create a view of the data containing only the column pertaining to coauthors count. -->
@@ -54,6 +60,16 @@
                     chartType: 'ls',
                     chartLabel: 'r'
                 }
+                
+                /*
+                This means that all the publications have unknown years & we do not need to display
+                the sparkline.
+                */            
+                if (unknownYearPublicationCounts > 0 && knownYearPublicationCounts < 1) {
+                    
+                    onlyUnknownYearPublications = true;
+                    
+                } else {
 
                 /* 
                 Test if we want to go for the approach when serving visualizations from a secure site..
@@ -106,6 +122,10 @@
                     );
                 
                 }
+                
+                }
+                
+                var totalPublicationCount = knownYearPublicationCounts + unknownYearPublicationCounts;
          
                 <#if sparklineVO.shortVisMode>
          
@@ -116,10 +136,27 @@
                     $.each(shortSparkRows, function(index, value) {
                         renderedShortSparks += data.getValue(value, 1);
                     });
+                    
+                     /*
+                    In case that there are only unknown publications we want the text to mention these counts,
+                    which would not be mentioned in the other case because the renderedShortSparks only hold counts
+                    of publications which have any date associated with it.
+                    */
+                    var totalPubs = onlyUnknownYearPublications ? unknownYearPublicationCounts : renderedShortSparks;
+                    
+                    if (totalPubs === 1) {
+                        var pubDisplay = "co-author";
+                    } else {
+                        var pubDisplay = "co-authors";
+                    }
          
-                    $('#${sparklineContainerID} td.sparkline_number').text(parseInt(renderedShortSparks) + parseInt(${sparklineVO.unknownYearPublications})).css("font-weight", "bold").attr("class", "grey").append("<span style='color: #2485AE;'> co-author(s) <br/></span>");
+                    $('#${sparklineContainerID} td.sparkline_number').text(totalPubs).css("font-weight", "bold").attr("class", "grey").append("<span style='color: #2485AE;'> " + pubDisplay + " <br/></span>");
             
                     var sparksText = '  within the last 10 years';
+                                        
+                    if (totalPubs !== totalPublicationCount) {
+                        sparksText += ' (' + totalPublicationCount + ' total)';
+                    }
             
                  <#else>
             
@@ -127,16 +164,37 @@
                      * Sparks that will be rendered will always be the one's which has 
                      * any year associated with it. Hence.
                      * */
-                    var renderedSparks = ${sparklineVO.renderedSparks};      
-                    $('#${sparklineContainerID} td.sparkline_number').text(parseInt(renderedSparks) + parseInt(${sparklineVO.unknownYearPublications})).css("font-weight", "bold").attr("class", "grey").append("<span style='color: #2485AE;'> co-author(s) <br/></span>");
+                    var renderedSparks = ${sparklineVO.renderedSparks};
+                    
+                    /*
+                    In case that there are only unknown publications we want the text to mention these counts,
+                    which would not be mentioned in the other case because the renderedSparks only hold counts
+                    of publications which have any date associated with it.
+                    */
+                    var totalPubs = onlyUnknownYearPublications ? unknownYearPublicationCounts : renderedSparks;
+                          
+                    if ( totalPubs == 1 ) {
+                        var pubDisplay = "co-author";
+                    } else {
+                        var pubDisplay = "co-authors";
+                    }
+                          
+                    $('#${sparklineContainerID} td.sparkline_number').text(totalPubs).css("font-weight", "bold").attr("class", "grey").append("<span style='color: #2485AE;'> " + pubDisplay + " <br/></span>");
             
                     var sparksText = '  from <span class="sparkline_range">${sparklineVO.earliestYearConsidered?c}' 
-                                        + ' to ${sparklineVO.latestRenderedPublicationYear?c}</span> ' 
-                                        + ' <br /><a href="${sparklineVO.downloadDataLink}">(.CSV File)</a> ';
+                                        + ' to ${sparklineVO.latestRenderedPublicationYear?c}</span>';
+                                        
+                    if (totalPubs !== totalPublicationCount) {
+                        sparksText += ' (' + totalPublicationCount + ' total)';
+                    }
+                                         
+                    sparksText += ' <br /><a href="${sparklineVO.downloadDataLink}">(.CSV File)</a> ';
                                         
                  </#if>
          
-                 $('#${sparklineContainerID} td.sparkline_text').html(sparksText);
+                 if (!onlyUnknownYearPublications) {
+                    $('#${sparklineContainerID} td.sparkline_text').html(sparksText);
+                 }
          
             }
     
@@ -179,16 +237,16 @@
                     sparklineImgTD.attr('class', 'sparkline_style');
             
                     row.append(sparklineImgTD);
-            		var row2 = $('<tr>');
+                    var row2 = $('<tr>');
                     var sparklineNumberTD = $('<td>');
                     sparklineNumberTD.attr('class', 'sparkline_number');
-					sparklineNumberTD.css('text-align', 'left');
+                    sparklineNumberTD.css('text-align', 'left');
                     row2.append(sparklineNumberTD);
                     var row3 = $('<tr>');
                     
                     var sparklineTextTD = $('<td>');
                     sparklineTextTD.attr('class', 'sparkline_text');
-					sparklineTextTD.css('text-align', 'left');
+                    sparklineTextTD.css('text-align', 'left');
                     row3.append(sparklineTextTD);
                     table.append(row);
                     table.append(row2);
@@ -214,20 +272,20 @@
 
             <#if displayTable?? && displayTable>
         
-		        <p>	
-					<#assign tableID = "coauthors_sparkline_data_table" />
-					<#assign tableCaption = "Unique Co-Authors per year " />
-					<#assign tableActivityColumnName = "Count" />
-					<#assign tableContent = sparklineVO.yearToActivityCount />
-					<#assign fileDownloadLink = sparklineVO.downloadDataLink />
-					
-					<#include "yearToActivityCountTable.ftl">
-		
-		            Download data as <a href="${sparklineVO.downloadDataLink}">.csv</a> file.
-		            <br />
-		        </p>
+                <p> 
+                    <#assign tableID = "coauthors_sparkline_data_table" />
+                    <#assign tableCaption = "Unique Co-Authors per year " />
+                    <#assign tableActivityColumnName = "Count" />
+                    <#assign tableContent = sparklineVO.yearToActivityCount />
+                    <#assign fileDownloadLink = sparklineVO.downloadDataLink />
+                    
+                    <#include "yearToActivityCountTable.ftl">
         
-	        </#if>
+                    Download data as <a href="${sparklineVO.downloadDataLink}">.csv</a> file.
+                    <br />
+                </p>
+        
+            </#if>
 
     </#if>
 </div>
\ No newline at end of file
diff --git a/productMods/templates/freemarker/visualization/copi/coInvestigationSparklineContent.ftl b/productMods/templates/freemarker/visualization/copi/coInvestigationSparklineContent.ftl
index 474fdbbf..032a9a4e 100644
--- a/productMods/templates/freemarker/visualization/copi/coInvestigationSparklineContent.ftl
+++ b/productMods/templates/freemarker/visualization/copi/coInvestigationSparklineContent.ftl
@@ -18,14 +18,20 @@
         
             function drawCoInvestigatorsSparklineVisualization(providedSparklineImgTD) {
     
+                var unknownYearGrantCounts = ${sparklineVO.unknownYearGrants};
+                var onlyUnknownYearGrants = false;
+                
                 var data = new google.visualization.DataTable();
                 data.addColumn('string', 'Year');
                 data.addColumn('number', 'Unique co-investigators');
                 data.addRows(${sparklineVO.yearToEntityCountDataTable?size});
+                
+                var knownYearGrantCounts = 0;
         
                 <#list sparklineVO.yearToEntityCountDataTable as yearToUniqueCoinvestigatorsDataElement>                        
                     data.setValue(${yearToUniqueCoinvestigatorsDataElement.yearToEntityCounter}, 0, '${yearToUniqueCoinvestigatorsDataElement.year}');
                     data.setValue(${yearToUniqueCoinvestigatorsDataElement.yearToEntityCounter}, 1, ${yearToUniqueCoinvestigatorsDataElement.currentEntitiesCount});
+                    knownYearGrantCounts += ${yearToUniqueCoinvestigatorsDataElement.currentEntitiesCount};
                 </#list>
         
                 <#-- Create a view of the data containing only the column pertaining to coinvestigators count. -->
@@ -54,6 +60,16 @@
                     chartType: 'ls',
                     chartLabel: 'r'
                 }
+                
+                /*
+                This means that all the publications have unknown years & we do not need to display
+                the sparkline.
+                */            
+                if (unknownYearGrantCounts > 0 && knownYearGrantCounts < 1) {
+                    
+                    onlyUnknownYearGrants = true;
+                    
+                } else {
 
                 /* 
                 Test if we want to go for the approach when serving visualizations from a secure site..
@@ -106,21 +122,42 @@
                     );
                 
                 }
-                              
+                
+                }
+                 
+                var totalGrantCount = knownYearGrantCounts + unknownYearGrantCounts;              
                 
                 <#if sparklineVO.shortVisMode>
                 
-                	<#-- We want to display how many coinvestigators were considered, so this is used to calculate this. -->
-                	
+                    <#-- We want to display how many coinvestigators were considered, so this is used to calculate this. -->
+                    
                     var shortSparkRows = sparklineDataView.getViewRows();
                     var renderedShortSparks = 0;
                     $.each(shortSparkRows, function(index, value) {
                         renderedShortSparks += data.getValue(value, 1);
                     });      
                     
-                    $('#${sparklineContainerID} td.sparkline_number').text(parseInt(renderedShortSparks) + parseInt(${sparklineVO.unknownYearGrants})).css("font-weight", "bold").attr("class", "grey").append("<span style='color: #2485AE;'> co-investigator(s) <br/></span>");
+                    /*
+                    In case that there are only unknown grants we want the text to mention these counts,
+                    which would not be mentioned in the other case because the renderedShortSparks only hold counts
+                    of grants which have any date associated with it.
+                    */
+                    var totalGrants = onlyUnknownYearGrants ? unknownYearGrantCounts : renderedShortSparks;
+                    
+                                        
+                    if (totalGrants === 1) {
+                        var grantDisplay = "co-investigator";
+                    } else {
+                        var grantDisplay = "co-investigators";
+                    }
+                    
+                    $('#${sparklineContainerID} td.sparkline_number').text(totalGrants).css("font-weight", "bold").attr("class", "grey").append("<span style='color: #2485AE;'> " + grantDisplay + " <br/></span>");
             
                     var sparksText = '  within the last 10 years';
+                    
+                    if (totalGrants !== totalGrantCount) {
+                        sparksText += ' (' + totalGrantCount + ' total)';
+                    }
             
                  <#else>
                        
@@ -128,15 +165,36 @@
                      * Sparks that will be rendered will always be the one's which has 
                      * any year associated with it. Hence.
                      * */
-                    var renderedSparks = ${sparklineVO.renderedSparks};      
-                    $('#${sparklineContainerID} td.sparkline_number').text(parseInt(renderedSparks) + parseInt(${sparklineVO.unknownYearGrants})).css("font-weight", "bold").attr("class", "grey").append("<span style='color: #2485AE;'> co-investigator(s) <br/></span>");
+                    var renderedSparks = ${sparklineVO.renderedSparks};     
+                    
+                    /*
+                    In case that there are only unknown grants we want the text to mention these counts,
+                    which would not be mentioned in the other case because the renderedSparks only hold counts
+                    of grants which have any date associated with it.
+                    */
+                    var totalGrants = onlyUnknownYearGrants ? unknownYearGrantCounts : renderedSparks;
+                    
+                    if (totalGrants === 1) {
+                        var grantDisplay = "co-investigator";
+                    } else {
+                        var grantDisplay = "co-investigators";
+                    }
+                     
+                    $('#${sparklineContainerID} td.sparkline_number').text(totalGrants).css("font-weight", "bold").attr("class", "grey").append("<span style='color: #2485AE;'> " + grantDisplay + " <br/></span>");
             
                     var sparksText = '  from <span class="sparkline_range">${sparklineVO.earliestYearConsidered?c}' 
-                                        + ' to ${sparklineVO.latestRenderedGrantYear?c}</span> ' 
-                                        + '<br /> <a href="${sparklineVO.downloadDataLink}">(.CSV File)</a> ';
+                                        + ' to ${sparklineVO.latestRenderedGrantYear?c}</span>';
+                                        
+                    if (totalGrants !== totalGrantCount) {
+                        sparksText += ' (' + totalGrantCount + ' total)';
+                    }
+                    
+                    sparksText += '<br /> <a href="${sparklineVO.downloadDataLink}">(.CSV File)</a> ';
                  </#if>
 
-                 $('#${sparklineContainerID} td.sparkline_text').html(sparksText).css("font-weight", "bold");    
+                 if (!onlyUnknownYearGrants) {
+                    $('#${sparklineContainerID} td.sparkline_text').html(sparksText).css("font-weight", "bold");
+                 } 
                  
            }
     
@@ -180,16 +238,16 @@
                     sparklineImgTD.attr('class', 'sparkline_style');
             
                     row.append(sparklineImgTD);
-            		var row2 = $('<tr>');
+                    var row2 = $('<tr>');
                     var sparklineNumberTD = $('<td>');
                     sparklineNumberTD.attr('class', 'sparkline_number');
-					sparklineNumberTD.css('text-align', 'left');
+                    sparklineNumberTD.css('text-align', 'left');
                     row2.append(sparklineNumberTD);
                     var row3 = $('<tr>');
                     
                     var sparklineTextTD = $('<td>');
                     sparklineTextTD.attr('class', 'sparkline_text');
-					sparklineTextTD.css('text-align', 'left');
+                    sparklineTextTD.css('text-align', 'left');
                     row3.append(sparklineTextTD);
                     table.append(row);
                     table.append(row2);
@@ -214,19 +272,19 @@
         <!-- For Full Sparkline - Print the Table of CoInvestigator Counts per Year -->
             <#if displayTable?? && displayTable>
         
-		        <p>	
-					<#assign tableID = "coinve_sparkline_data_table" />
-					<#assign tableCaption = "Unique Co-Investigators per year " />
-					<#assign tableActivityColumnName = "Count" />
-					<#assign tableContent = sparklineVO.yearToActivityCount />
-					<#assign fileDownloadLink = sparklineVO.downloadDataLink />
-					
-					<#include "yearToActivityCountTable.ftl">
-		
-		            Download data as <a href="${sparklineVO.downloadDataLink}">.csv</a> file.
-		            <br />
-		        </p>
+                <p> 
+                    <#assign tableID = "coinve_sparkline_data_table" />
+                    <#assign tableCaption = "Unique Co-Investigators per year " />
+                    <#assign tableActivityColumnName = "Count" />
+                    <#assign tableContent = sparklineVO.yearToActivityCount />
+                    <#assign fileDownloadLink = sparklineVO.downloadDataLink />
+                    
+                    <#include "yearToActivityCountTable.ftl">
         
-	        </#if>	
+                    Download data as <a href="${sparklineVO.downloadDataLink}">.csv</a> file.
+                    <br />
+                </p>
+        
+            </#if>  
     </#if>
 </div>
\ No newline at end of file