/**
* Licensed to Jasig under one or more contributor license
* agreements. See the NOTICE file distributed with this work
* for additional information regarding copyright ownership.
* Jasig licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a
* copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.jasig.portal.portlets.statistics;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import org.jasig.portal.events.aggr.AggregationInterval;
import org.jasig.portal.events.aggr.BaseAggregationDao;
import org.jasig.portal.events.aggr.concuser.ConcurrentUserAggregation;
import org.jasig.portal.events.aggr.concuser.ConcurrentUserAggregationDao;
import org.jasig.portal.events.aggr.concuser.ConcurrentUserAggregationDiscriminator;
import org.jasig.portal.events.aggr.concuser.ConcurrentUserAggregationDiscriminatorImpl;
import org.jasig.portal.events.aggr.concuser.ConcurrentUserAggregationKey;
import org.jasig.portal.events.aggr.concuser.ConcurrentUserAggregationKeyImpl;
import org.jasig.portal.events.aggr.groups.AggregatedGroupLookupDao;
import org.jasig.portal.events.aggr.groups.AggregatedGroupMapping;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.portlet.ModelAndView;
import org.springframework.web.portlet.bind.annotation.RenderMapping;
import org.springframework.web.portlet.bind.annotation.ResourceMapping;
import com.google.visualization.datasource.base.TypeMismatchException;
import com.google.visualization.datasource.datatable.ColumnDescription;
import com.google.visualization.datasource.datatable.value.NumberValue;
import com.google.visualization.datasource.datatable.value.Value;
import com.google.visualization.datasource.datatable.value.ValueType;
/**
* Concurrent User Reports
*
* @author edalquist
*/
@Controller
@RequestMapping("VIEW")
public class ConcurrentUsersStatisticsController
extends BaseSimpleGroupedStatisticsReportController<
ConcurrentUserAggregation,
ConcurrentUserAggregationKey,
ConcurrentUserAggregationDiscriminator,
ConcurrentUserReportForm> {
private static final String DATA_TABLE_RESOURCE_ID = "concurrentUserData";
private final static String REPORT_NAME = "concurrent.users";
@Autowired
private ConcurrentUserAggregationDao<ConcurrentUserAggregation> concurrentUserAggregationDao;
@Autowired
private AggregatedGroupLookupDao aggregatedGroupDao;
@RenderMapping(value="MAXIMIZED", params="report=" + REPORT_NAME)
public String getConcurrentUserView() throws TypeMismatchException {
return "jsp/Statistics/reportGraph";
}
@ResourceMapping(DATA_TABLE_RESOURCE_ID)
public ModelAndView renderConcurrentUserAggregationReport(ConcurrentUserReportForm form) throws TypeMismatchException {
return renderAggregationReport(form);
}
@Override
public String getReportName() {
return REPORT_NAME;
}
@Override
public String getReportDataResourceId() {
return DATA_TABLE_RESOURCE_ID;
}
@Override
protected BaseAggregationDao<ConcurrentUserAggregation, ConcurrentUserAggregationKey> getBaseAggregationDao() {
return this.concurrentUserAggregationDao;
}
@Override
protected Comparator<? super ConcurrentUserAggregationDiscriminator> getDiscriminatorComparator() {
return ConcurrentUserAggregationDiscriminatorImpl.Comparator.INSTANCE;
}
/**
* Create a map of the report column discriminators based on the submitted form to
* collate the aggregation data into each column of a report.
* The map entries are a time-ordered sorted set of aggregation data points.
*
* @param form Form submitted by the user
* @return Map of report column discriminators to sorted set of time-based aggregation data
*/
@Override
protected Map<ConcurrentUserAggregationDiscriminator, SortedSet<ConcurrentUserAggregation>>
createColumnDiscriminatorMap (ConcurrentUserReportForm form){
return getDefaultGroupedColumnDiscriminatorMap(form);
}
@Override
protected Set<ConcurrentUserAggregationKey> createAggregationsQueryKeyset(Set<ConcurrentUserAggregationDiscriminator> groups, ConcurrentUserReportForm form) {
final AggregationInterval interval = form.getInterval();
HashSet<ConcurrentUserAggregationKey> keys = new HashSet<ConcurrentUserAggregationKey>();
keys.add(new ConcurrentUserAggregationKeyImpl(interval, groups.iterator().next().getAggregatedGroup()));
return keys;
}
@Override
protected List<ColumnDescription> getColumnDescriptions(ConcurrentUserAggregationDiscriminator discriminator, ConcurrentUserReportForm form) {
final String groupName = discriminator.getAggregatedGroup().getGroupName();
return Collections.singletonList(new ColumnDescription(groupName, ValueType.NUMBER, groupName));
}
@Override
protected List<Value> createRowValues(ConcurrentUserAggregation aggr, ConcurrentUserReportForm form) {
final int concurrentUsers;
if (aggr == null) {
concurrentUsers = 0;
}
else {
concurrentUsers = aggr.getConcurrentUsers();
}
return Collections.<Value>singletonList(new NumberValue(concurrentUsers));
}
@Override
protected ConcurrentUserAggregationDiscriminator createGroupedDiscriminatorInstance(AggregatedGroupMapping groupMapping) {
return new ConcurrentUserAggregationDiscriminatorImpl(groupMapping);
}
}