source: contrib/MailArchiver/sources/src/serpro/mailarchiver/domain/metaarchive/Field.java @ 6785

/**
 * MailArchiver is an application that provides services for storing and managing e-mail messages through a Web Services SOAP interface.
 * Copyright (C) 2012  Marcio Andre Scholl Levien and Fernando Alberto Reuter Wendt and Jose Ronaldo Nogueira Fonseca Junior
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/******************************************************************************\
*
*  This product was developed by
*
*        SERVIÇO FEDERAL DE PROCESSAMENTO DE DADOS (SERPRO),
*
*  a government company established under Brazilian law (5.615/70),
*  at Department of Development of Porto Alegre.
*
\******************************************************************************/

package serpro.mailarchiver.domain.metaarchive;

import javax.jdo.annotations.NotPersistent;
import javax.jdo.annotations.PersistenceCapable;

import org.apache.commons.lang3.exception.ExceptionUtils;

import com.google.common.base.Strings;

import serpro.mailarchiver.domain.BaseObject;
import serpro.mailarchiver.util.Logger;

@PersistenceCapable
public abstract class Field
    extends BaseObject
{
    @NotPersistent
    private static final Logger log = Logger.getLocalLogger();

    //**** P E R S I S T E N T ****
    private String oid;
    private String name;
    private boolean valid = true;
    private String parseExceptionStackTrace;
    private Entity entity;
    private Integer entityIdx;
    //*****************************

    public Message getRootMessage() {
        if(getEntity() != null) {
            return getEntity().getRootMessage();
        }
        return null;
    }

    public String getOid() {
        return oid;
    }

    public void setOid(String oid) {
        this.oid = oid;
    }

    public String getName() {
        return name;
    }

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

    public boolean isValid() {
        return valid;
    }

    public void setValid(boolean valid) {
        this.valid = valid;
    }

    public String getParseExceptionStackTrace() {
        return parseExceptionStackTrace;
    }

    public void setParseExceptionStackTrace(String parseExceptionStackTrace) {
        this.parseExceptionStackTrace = parseExceptionStackTrace;
    }

    //--------------------------------------------------------------------------
    public Entity getEntity() {
        return entity;
    }

    public void setEntity(Entity entity) {
        if(this.entity != null) {
            this.entity.internal_removeField(this);
        }
        this.entity = entity;
        if(this.entity != null) {
            this.entity.internal_addField(this);
        }
    }

    public final int getEntityIdx() {
        return (entityIdx != null) ? entityIdx
                : (getEntity() != null) ? getEntity().indexOf(this)
                : -1;
    }

    //--------------------------------------------------------------------------
    public final String dumpPath() {
        StringBuilder sb = new StringBuilder();
        dumpPath(sb, true);
        return sb.toString();
    }

    final int dumpPath(StringBuilder sb, boolean quit) {
        int depth = (entity == null) ? 0 : entity.dumpPath(sb, false);
        String pad = Strings.repeat("    ", depth);
        if(quit) {
            sb.append(toString(pad + "    "));
        }
        else {
            sb.append(toString(pad + "|   ")).append("\n")
              .append(pad).append("|\n")
              .append(pad).append("+---");
        }
        return ++depth;
    }

    public final String dumpTree() {
        StringBuilder sb = new StringBuilder();
        dumpTree(sb, "");
        return sb.toString();
    }

    abstract void dumpTree(StringBuilder sb, String pad);

    @Override
    public final String toString() {
        return toString("    ");
    }

    abstract String toString(String pad);

    //--------------------------------------------------------------------------
    public void addParseExceptionStackTrace(Throwable t) {
        StringBuilder sb = new StringBuilder();
        String st = getParseExceptionStackTrace();
        if(st != null) {
            sb.append(st).append("\n\n");
        }
        sb.append("######## PARSE EXCEPTION ########\n")
          .append(t.toString()).append("\n\n")
          .append(ExceptionUtils.getStackTrace(t));

        setParseExceptionStackTrace(sb.toString());
    }
}