Java tutorial
/** * The software subject to this notice and license includes both human readable * source code form and machine readable, binary, object code form. The NCI OCR * Software was developed in conjunction with the National Cancer Institute * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent * government employees are authors, any rights in such works shall be subject * to Title 17 of the United States Code, section 105. * * This NCI OCR Software License (the License) is between NCI and You. You (or * Your) shall mean a person or an entity, and all other entities that control, * are controlled by, or are under common control with the entity. Control for * purposes of this definition means (i) the direct or indirect power to cause * the direction or management of such entity, whether by contract or otherwise, * or (ii) ownership of fifty percent (50%) or more of the outstanding shares, * or (iii) beneficial ownership of such entity. * * This License is granted provided that You agree to the conditions described * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up, * no-charge, irrevocable, transferable and royalty-free right and license in * its rights in the NCI OCR Software to (i) use, install, access, operate, * execute, copy, modify, translate, market, publicly display, publicly perform, * and prepare derivative works of the NCI OCR Software; (ii) distribute and * have distributed to and by third parties the NCI OCR Software and any * modifications and derivative works thereof; and (iii) sublicense the * foregoing rights set out in (i) and (ii) to third parties, including the * right to license such rights to further third parties. For sake of clarity, * and not by way of limitation, NCI shall have no right of accounting or right * of payment from You or Your sub-licensees for the rights granted under this * License. This License is granted at no charge to You. * * Your redistributions of the source code for the Software must retain the * above copyright notice, this list of conditions and the disclaimer and * limitation of liability of Article 6, below. Your redistributions in object * code form must reproduce the above copyright notice, this list of conditions * and the disclaimer of Article 6 in the documentation and/or other materials * provided with the distribution, if any. * * Your end-user documentation included with the redistribution, if any, must * include the following acknowledgment: This product includes software * developed by 5AM and the National Cancer Institute. If You do not include * such end-user documentation, You shall include this acknowledgment in the * Software itself, wherever such third-party acknowledgments normally appear. * * You may not use the names "The National Cancer Institute", "NCI", or "5AM" * to endorse or promote products derived from this Software. This License does * not authorize You to use any trademarks, service marks, trade names, logos or * product names of either NCI or 5AM, except as required to comply with the * terms of this License. * * For sake of clarity, and not by way of limitation, You may incorporate this * Software into Your proprietary programs and into any third party proprietary * programs. However, if You incorporate the Software into third party * proprietary programs, You agree that You are solely responsible for obtaining * any permission from such third parties required to incorporate the Software * into such third party proprietary programs and for informing Your * sub-licensees, including without limitation Your end-users, of their * obligation to secure any required permissions from such third parties before * incorporating the Software into such third party proprietary software * programs. In the event that You fail to obtain such permissions, You agree * to indemnify NCI for any claims against NCI by such third parties, except to * the extent prohibited by law, resulting from Your failure to obtain such * permissions. * * For sake of clarity, and not by way of limitation, You may add Your own * copyright statement to Your modifications and to the derivative works, and * You may provide additional or different license terms and conditions in Your * sublicenses of modifications of the Software, or any derivative works of the * Software as a whole, provided Your use, reproduction, and distribution of the * Work otherwise complies with the conditions stated in this License. * * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package gov.nih.nci.firebird.web.common; import gov.nih.nci.firebird.data.AbstractProtocolRegistration; import gov.nih.nci.firebird.data.InvestigatorRegistration; import gov.nih.nci.firebird.data.InvitationStatus; import gov.nih.nci.firebird.data.Person; import gov.nih.nci.firebird.data.RegistrationStatus; import java.io.Serializable; import java.text.SimpleDateFormat; import java.util.Arrays; import java.util.Locale; import java.util.Set; import java.util.regex.Pattern; import org.apache.commons.lang3.builder.CompareToBuilder; import org.apache.struts2.json.JSONException; import org.apache.struts2.json.JSONUtil; import com.google.common.collect.Lists; import com.opensymphony.xwork2.ActionSupport; /** * A Class to handle the conversion from a Registration list to JSON for table usage. */ public final class RegistrationJsonConverter { private RegistrationJsonConverter() { // avoid instantiation } /** * convert registrations for consumption by inviteDialog.tag. * * @param action action to help with formated strings * @param registrations the registrations to show in table * @return JSON table data of registration * @throws JSONException error */ public static String convertToJson(ActionSupport action, Set<? extends AbstractProtocolRegistration> registrations) throws JSONException { Row[] rows = new Row[registrations.size()]; int i = 0; for (AbstractProtocolRegistration reg : registrations) { rows[i++] = new Row(action, reg); } Arrays.sort(rows); return JSONUtil.serialize(rows, Lists.newArrayList(Pattern.compile(".*\\.byteDataSource")), null, false, true, false); } /** * JSON response for grid rows. */ @SuppressWarnings("ucd") // needs to be public for JSONUtil.serialize() public static class Row implements Serializable, Comparable<Row> { private static final long serialVersionUID = 1L; private final SimpleDateFormat dateFormat; private final AbstractProtocolRegistration registration; private final ActionSupport action; /** * @param action action to help with formated strings * @param reg the registration for this row. */ Row(ActionSupport action, AbstractProtocolRegistration reg) { this.registration = reg; this.action = action; dateFormat = new SimpleDateFormat(action.getText("date.format.timestamp"), Locale.getDefault()); } /** * @return registration id. */ public Long getId() { return registration.getId(); } /** * @return investigator in registration. */ public Person getInvestigator() { return registration.getProfile().getPerson(); } /** * @return registration status text. */ public String getStatusText() { if (registration.getStatus() == RegistrationStatus.NOT_STARTED) { return registration.getStatus().getDisplay(); } String[] args = { registration.getStatus().getDisplay(), getStatusDateDisplay() }; return action.getText("registration.status.with.date", args); } private String getStatusDateDisplay() { return dateFormat.format(registration.getStatusDate()); } /** * @return the invitation status object. */ public InvitationStatus getInvitationStatus() { return registration.getInvitation().getInvitationStatus(); } /** * @return invitation status text with date. */ public String getInvitationStatusText() { String key = registration.getInvitation().getInvitationStatus().getKey() + ".with.date"; String[] args = { dateFormat.format(registration.getInvitation().getInvitationChangeDate()) }; return action.getText(key, args); } /** * @return primary registration id. */ public Long getPrimaryRegistrationId() { return registration.getPrimaryRegistration() == null ? null : registration.getPrimaryRegistration().getId(); } /** * @return investigator in registration. */ public Person getPrimaryInvestigator() { return registration.getPrimaryRegistration() == null ? null : registration.getPrimaryRegistration().getProfile().getPerson(); } /** * @return the comments */ public String getComments() { return registration.getSponsorComments(); } /** * @return current registration's id (only if revised). */ public Long getCurrentRegistrationId() { if (registration.getCurrentRegistration() != null) { return registration.getCurrentRegistration().getId(); } return null; } @Override public int compareTo(Row other) { return new CompareToBuilder() .appendSuper(InvestigatorRegistration.INVESTIGATOR_NAME_COMPARATOR.compare(this.registration, other.registration)) .append(getCurrentRegistrationId(), other.getCurrentRegistrationId()).toComparison(); } } }