com.imsweb.validation.entities.ContextEntry Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2010 Information Management Services, Inc.
 */
package com.imsweb.validation.entities;

import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

/**
 * A context entry is one context variable in a {@link Validator} object.
 * 
 * Created on Apr 5, 2011 by depryf
 */
public class ContextEntry {

    /**
     * DB ID for this context entry
     */
    protected Long _contextEntryId;

    /**
     * Context key (must be unique in the entire validation engine)
     */
    protected String _key;

    /**
     * Context expression
     */
    protected String _expression;

    /**
     * Parent Validator
     */
    protected Validator _validator;

    /**
     * Context type ("java" or "groovy")
     */
    protected String _type;

    /**
     * Getter for the context entry persistence ID. Must be unique within the validation engine.
     * 

     * In a system persisting the context entries in a database, that would represent a database primary key.
     * In a system using only memory objects loaded from XML, it should be assigned using the
     * getNextContextEntrySequence() method in ValidatorServices.
     * 

     * Created on Mar 10, 2011 by depryf
     * @return the contextEntryId persistence ID
     */
    public Long getContextEntryId() {
        return _contextEntryId;
    }

    /**
     * Setter for the context entry persistence ID. Must be unique within the validation engine.
     * 

     * In a system persisting the context entries in a database, that would represent a database primary key.
     * In a system using only memory objects loaded from XML, it should be assigned using the
     * getNextContextEntrySequence() method in ValidatorServices.
     * 

     * Created on Mar 10, 2011 by depryf
     * @param contextEntryId rule persistence ID
     */
    public void setContextEntryId(Long contextEntryId) {
        _contextEntryId = contextEntryId;
    }

    /**
     * Getter for the context key.
     * 

     * Created on Apr 5, 2011 by depryf
     * @return context key
     */
    public String getKey() {
        return _key;
    }

    /**
     * Setter for the context key.
     * 

     * Created on Apr 5, 2011 by depryf
     * @param key context key
     */
    public void setKey(String key) {
        this._key = key;
    }

    /**
     * Getter for the expression.
     * 

     * Created on Apr 5, 2011 by depryf
     * @return expression
     */
    public String getExpression() {
        return _expression;
    }

    /**
     * Setter for the expression.
     * 

     * Created on Apr 5, 2011 by depryf
     * @param expression expression
     */
    public void setExpression(String expression) {
        this._expression = expression;
    }

    /**
     * Getter for the validator.
     * 

     * Created on Apr 5, 2011 by depryf
     * @return the Validator
     */
    public Validator getValidator() {
        return _validator;
    }

    /**
     * Setter for the validator.
     * 

     * Created on Apr 5, 2011 by depryf
     * @param validator the Validator
     */
    public void setValidator(Validator validator) {
        this._validator = validator;
    }

    /**
     * Getter for the type.
     * 

     * Created on Apr 5, 2011 by depryf
     * @return the type
     */
    public String getType() {
        return _type;
    }

    /**
     * Setter for the type.
     * 
     * Created on Apr 5, 2011 by depryf
     * @param type the type
     */
    public void setType(String type) {
        this._type = type;
    }

    @Override
    public String toString() {
        return _key;
    }

    @Override
    public boolean equals(Object other) {
        if (!(other instanceof ContextEntry))
            return false;
        ContextEntry castOther = (ContextEntry)other;
        if (getContextEntryId() != null)
            return new EqualsBuilder().append(getContextEntryId(), castOther.getContextEntryId()).isEquals();
        else
            return new EqualsBuilder().append(getKey(), castOther.getKey()).isEquals();
    }

    @Override
    public int hashCode() {
        if (getContextEntryId() != null)
            return new HashCodeBuilder().append(getContextEntryId()).toHashCode();
        else
            return new HashCodeBuilder().append(getKey()).toHashCode();
    }

}