PoliticianRankingDataGridPageModContentFactoryImpl.java

/*
 * Copyright 2010-2024 James Pether Sörling
 *
 * Licensed 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.
 *
 *	$Id$
 *  $HeadURL$
*/
package com.hack23.cia.web.impl.ui.application.views.user.politician.pagemode;

import org.apache.commons.lang3.StringUtils;
import org.springframework.security.access.annotation.Secured;
import org.springframework.stereotype.Service;

import com.hack23.cia.model.internal.application.data.politician.impl.ViewRiksdagenPolitician;
import com.hack23.cia.model.internal.application.data.politician.impl.ViewRiksdagenPolitician_;
import com.hack23.cia.model.internal.application.system.impl.ApplicationEventGroup;
import com.hack23.cia.service.api.DataContainer;
import com.hack23.cia.web.impl.ui.application.action.ViewAction;
import com.hack23.cia.web.impl.ui.application.views.common.viewnames.PageMode;
import com.hack23.cia.web.impl.ui.application.views.common.viewnames.UserViews;
import com.hack23.cia.web.impl.ui.application.views.pageclicklistener.PageItemPropertyClickListener;
import com.vaadin.ui.Layout;
import com.vaadin.ui.MenuBar;
import com.vaadin.ui.Panel;
import com.vaadin.ui.VerticalLayout;


/**
 * The Class PoliticianRankingDataGridPageModContentFactoryImpl.
 */
@Service
public final class PoliticianRankingDataGridPageModContentFactoryImpl
		extends AbstractPoliticianRankingPageModContentFactoryImpl {

	/** The Constant COLUMN_ORDER. */
	private static final String[] COLUMN_ORDER = {
		    // Basic Information
		    "personId",
		    "firstName",
		    "lastName",
		    "party",
		    "gender",

		    // Current Activity & Performance
		    "documentsLastYear",          // Recent activity
		    "averageDocsPerYear",        // Productivity metric
		    "docActivityLevel",          // Activity classification
		    "docActivityProfile",        // Work style
		    "collaborationPercentage",   // Team player metric

		    // Document Breakdown
		    "totalDocuments",            // Total contribution
		    "individualMotions",         // Individual initiatives
		    "partyMotions",             // Party work
		    "committeeMotions",          // Committee work
		    "multiPartyMotions",        // Collaboration metric

		    // Current Roles
		    "currentAssignments",
		    "currentMinistryAssignments",
		    "currentCommitteeAssignments",
		    "currentCommitteeLeadershipAssignments",

		    // Historical Performance
		    "documentYearsActive",       // Experience metric
		    "totalDaysServed",
		    "totalCommitteeAssignments",
		    "totalMinistryAssignments",

		    // Dates for Context
		    "firstAssignmentDate",
		    "lastAssignmentDate",
		    "firstDocumentDate",
		    "lastDocumentDate"
		};

	/** The Constant HIDE_COLUMNS. */
	/** The Constant HIDE_COLUMNS. */
	private static final String[] HIDE_COLUMNS = {
	    // Hidden IDs and Boolean Flags
	    "personId",
	    "active",
	    "activeEu",
	    "activeGovernment",
	    "activeCommittee",
	    "activeParliament",
	    "activeParty",
	    "activeSpeaker",
	    "bornYear",

	    // Hidden Detail Metrics
	    "followUpMotions",
	    "totalDaysServedParliament",
	    "totalDaysServedCommittee",
	    "totalDaysServedGovernment",
	    "totalDaysServedEu",
	    "totalDaysServedSpeaker",
	    "totalDaysServedParty",
	    "totalDaysServedCommitteeSubstitute",
	    "totalDaysServedCommitteeLeadership",

	    // Hidden Assignment Details
	    "totalPartyAssignments",
	    "totalSpeakerAssignments",
	    "currentPartyAssignments",
	    "currentSpeakerAssignments",
	    "totalCommitteeSubstituteAssignments",
	    "currentCommitteeSubstituteAssignments",

	    // Hidden Technical Fields
	    "documentTypes",
	    "documentTypesString"
	};

	/** The Constant LISTENER. */
	private static final PageItemPropertyClickListener LISTENER = new PageItemPropertyClickListener(UserViews.POLITICIAN_VIEW_NAME, "personId");

	/** The Constant NAME. */
	public static final String NAME = UserViews.POLITICIAN_RANKING_VIEW_NAME;

	/** The Constant POLITICIANS. */
	private static final String POLITICIANS = "Politicians";

	/**
	 * Instantiates a new politician ranking data grid page mod content factory
	 * impl.
	 */
	public PoliticianRankingDataGridPageModContentFactoryImpl() {
		super();
	}

	@Secured({ "ROLE_ANONYMOUS", "ROLE_USER", "ROLE_ADMIN" })
	@Override
	public Layout createContent(final String parameters, final MenuBar menuBar, final Panel panel) {
		final VerticalLayout panelContent = createPanelContent();

		getPoliticianRankingMenuItemFactory().createPoliticianRankingMenuBar(menuBar);
		createPageHeader(panel, panelContent, "Politician Performance Overview", "Politician Rankings", "Review rankings of politicians based on tenure, contributions, and performance metrics.");

		final String pageId = getPageId(parameters);

		final DataContainer<ViewRiksdagenPolitician, String> politicianDataContainer = getApplicationManager()
				.getDataContainer(ViewRiksdagenPolitician.class);

		getGridFactory().createBasicBeanItemGrid(panelContent, ViewRiksdagenPolitician.class, politicianDataContainer.findListByProperty(
				new Object[] { Boolean.TRUE }, ViewRiksdagenPolitician_.active),
				POLITICIANS,
				COLUMN_ORDER, HIDE_COLUMNS, LISTENER, null, null);


		getPageActionEventHelper().createPageEvent(ViewAction.VISIT_POLITICIAN_RANKING_VIEW, ApplicationEventGroup.USER,
				NAME, parameters, pageId);

		return panelContent;

	}

	@Override
	public boolean matches(final String page, final String parameters) {
		return NAME.equals(page)
				&& StringUtils.contains(parameters, PageMode.DATAGRID.toString());
	}

}