org.icgc.dcc.submission.dictionary.model.Field.java Source code

Introduction

Here is the source code for org.icgc.dcc.submission.dictionary.model.Field.java

Source

/*
 * Copyright (c) 2013 The Ontario Institute for Cancer Research. All rights reserved.                             
 *                                                                                                               
 * This program and the accompanying materials are made available under the terms of the GNU Public License v3.0.
 * You should have received a copy of the GNU General Public License along with                                  
 * this program. If not, see <http://www.gnu.org/licenses/>.                                                     
 *                                                                                                               
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY                           
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES                          
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT                           
 * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 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 org.icgc.dcc.submission.dictionary.model;

import static org.icgc.dcc.submission.dictionary.model.RestrictionType.CODELIST;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import javax.validation.Valid;

import lombok.ToString;
import lombok.val;

import org.hibernate.validator.constraints.NotBlank;
import org.icgc.dcc.core.model.ValueType;
import org.icgc.dcc.submission.dictionary.visitor.DictionaryElement;
import org.icgc.dcc.submission.dictionary.visitor.DictionaryVisitor;
import org.mongodb.morphia.annotations.Embedded;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import com.google.common.collect.Iterables;

/**
 * Describes a field that has {@code Restriction}s and that is part of a {@code FileSchema}
 */
@Embedded
@ToString(of = { "name", "valueType" })
public class Field implements DictionaryElement, Serializable {

    public static final Predicate<Field> IS_CONTROLLED = new Predicate<Field>() {

        @Override
        public boolean apply(Field field) {
            return field.isControlled();
        }
    };

    @NotBlank
    private String name;

    private String label;

    private ValueType valueType;

    private SummaryType summaryType;

    @Valid
    private List<Restriction> restrictions;

    private boolean controlled;

    public Field() {
        super();
        this.restrictions = new ArrayList<Restriction>();
    }

    public Field(Field field) {
        super();
        this.name = field.getName();
        this.label = field.getLabel();
        this.valueType = field.getValueType();
        this.summaryType = field.getSummaryType();
        this.restrictions = field.getRestrictions();
    }

    @Override
    public void accept(DictionaryVisitor dictionaryVisitor) {
        dictionaryVisitor.visit(this);

        for (Restriction restriction : restrictions) {
            restriction.accept(dictionaryVisitor);
        }
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getLabel() {
        return label;
    }

    public void setLabel(String label) {
        this.label = label;
    }

    public ValueType getValueType() {
        return valueType;
    }

    public void setValueType(ValueType valueType) {
        this.valueType = valueType;
    }

    public List<Restriction> getRestrictions() {
        return restrictions;
    }

    public void setRestrictions(List<Restriction> restrictions) {
        this.restrictions = restrictions;
    }

    public void addRestriction(Restriction restriction) {
        val type = restriction.getType();
        val present = getRestriction(type).isPresent();
        if (!type.isMulti() && present) {
            throw new DuplicateRestrictionFoundException(
                    "Duplicate Restriction found with type: " + restriction.getType());
        }
        this.restrictions.add(restriction);
    }

    /**
     * FIXME: https://jira.oicr.on.ca/browse/DCC-2087
     */
    @JsonIgnore
    public Optional<Restriction> getRestriction(final RestrictionType type) {
        return Iterables.tryFind(this.restrictions, new Predicate<Restriction>() {

            @Override
            public boolean apply(Restriction input) {
                return input.getType() == type;
            }

        });
    }

    @JsonIgnore
    public Optional<Restriction> getCodeListRestriction() {
        return getRestriction(CODELIST);
    }

    public boolean removeRestriction(Restriction restriction) {
        return this.restrictions.remove(restriction);
    }

    public SummaryType getSummaryType() {
        return summaryType;
    }

    public void setSummaryType(SummaryType summaryType) {
        this.summaryType = summaryType;
    }

    public boolean isControlled() {
        return controlled;
    }

    public void setControlled(boolean controlled) {
        this.controlled = controlled;
    }

    public boolean hasCodeListRestriction() {
        return hasRestriction(RestrictionType.CODELIST);
    }

    public boolean hasInRestriction() {
        return hasRestriction(RestrictionType.DISCRETE_VALUES);
    }

    public boolean hasRequiredRestriction() {
        return hasRestriction(RestrictionType.REQUIRED);
    }

    public boolean hasRegexRestriction() {
        return hasRestriction(RestrictionType.REGEX);
    }

    private boolean hasRestriction(RestrictionType type) {
        for (Restriction restriction : restrictions) {
            if (type == restriction.getType()) {
                return true;
            }
        }
        return false;
    }

}