com.credibledoc.iso8583packer.navigator.NavigatorService Maven / Gradle / Ivy

Go to download
package com.credibledoc.iso8583packer.navigator;

import com.credibledoc.iso8583packer.dump.Visualizer;
import com.credibledoc.iso8583packer.exception.PackerRuntimeException;
import com.credibledoc.iso8583packer.hex.HexService;
import com.credibledoc.iso8583packer.message.*;
import com.credibledoc.iso8583packer.tag.TagPacker;

import java.util.List;
import java.util.Objects;

/**
 * The service contains methods for navigation (jumping) inside the {@link MsgField}s graph.
 * 
 * @author Kyrylo Semenko
 */
public class NavigatorService implements Navigator {
    
    private static NavigatorService instance;
    
    protected Visualizer visualizer;

    /**
     * Static factory.
     * @return The single instance of the {@link NavigatorService}. 
     */
    public static NavigatorService getInstance() {
        if (instance == null) {
            instance = new NavigatorService();
        }
        return instance;
    }

    /**
     * Please use the {@link #getInstance()} method instead of this constructor.
     */
    public NavigatorService() {
        // empty
    }

    @Override
    @SuppressWarnings("unchecked")
    public  T findByName(List msgList, String name) {
        if (name == null) {
            return null;
        }
        if (msgList == null) {
            return null;
        }
        for (Msg nextMsgField : msgList) {
            if (name.equals(nextMsgField.getName())) {
                return (T) nextMsgField;
            }
        }
        return null;
    }

    @Override
    public MsgField getChildOrThrowException(String childName, MsgField currentMsgField) {
        List msgFields = currentMsgField.getChildren();
        MsgField child = findByName(msgFields, childName);
        if (child == null) {
            MsgField rootMsgField = findRoot(currentMsgField);
            String root = visualizer.dumpMsgField(rootMsgField);
            throw new PackerRuntimeException("Field with name '" + getPathRecursively(currentMsgField) +
                "' has no child with name '" + childName + "'. Current field: " + currentMsgField + "\n" +
                "Root MsgField:\n" + root);
        }
        return child;
    }

    @Override
    public String generatePath(Msg current) {
        String tagOrFieldNum = null;
        if (current.getTag() != null) {
            if (current.getTag() instanceof byte[]) {
                byte[] tag = (byte[]) current.getTag();
                tagOrFieldNum = HexService.bytesToHex(tag);
            } else {
                tagOrFieldNum = current.getTag().toString();
            }
        } else if (current.getFieldNum() != null) {
            tagOrFieldNum = current.getFieldNum().toString();
        }
        if (tagOrFieldNum != null) {
            if (current.getName() != null) {
                return current.getName() + "(" + tagOrFieldNum + ")";
            }
            return tagOrFieldNum;
        }
        if (current.getName() == null && current instanceof MsgField) {
            MsgField msgField = (MsgField) current;
            return msgField.getType().toString();
        }
        return current.getName();
    }

    /**
     * Call the {@link #generatePath(Msg)} method recursively.
     * @param current focused node in the object graph
     * @param prefix can be 'null'. If exists, a result will contain this prefix.
     * @return 'null' if name nor num has been set.
     */
    protected String generatePathRecursively(Msg current, String prefix) {
        if (prefix == null) {
            prefix = "";
        }
        if (current.getParent() != null) {
            prefix = generatePathRecursively(current.getParent(), prefix);
            prefix = prefix + "." + generatePath(current);
        } else {
            prefix = prefix + generatePath(current);
        }
        return prefix;
    }

    @Override
    public String getPathRecursively(Msg msg) {
        if (msg == null) {
            return null;
        }
        return generatePathRecursively(msg, null);
    }

    @Override
    @SuppressWarnings("unchecked")
    public  T findRoot(T msg) {
        if (msg.getParent() == null) {
            return msg;
        }
        return (T)findRoot(msg.getParent());
    }

    @Override
    public TagPacker getTagPacker(MsgField msgField) {
        if (MsgFieldType.isNotTaggedType(msgField)) {
            return null;
        }
        if (msgField.getTagPacker() != null) {
            return msgField.getTagPacker();
        }
        if (msgField.getParent() != null) {
            return msgField.getParent().getChildrenTagPacker();
        }
        throw new PackerRuntimeException("The field '" + getPathRecursively(msgField) +
                "' has no tagPacker and its parent has no childrenTagPacker defined. " +
            "TagPacker is mandatory for '" + MsgFieldType.getTaggedTypes() +
            "' field types.");
    }

    @Override
    public MsgField getSiblingOrThrowException(String siblingName, MsgField currentMsgField) {
        if (currentMsgField.getParent() == null) {
            throw new PackerRuntimeException("Field '" + getPathRecursively(currentMsgField) +
                    "' has no parent, hence it cannot have a sibling with name '" + siblingName + "'");
        }
        MsgField parentMsgField = currentMsgField.getParent();
        return getChildOrThrowException(siblingName, parentMsgField);
    }

    @Override
    public MsgField findByNameAndTagOrThrowException(MsgField msgField, MsgValue msgValue) {
        MsgField rootMsgField = findRoot(msgField);
        MsgField result = findInGraphRecurrently(msgValue, rootMsgField);
        if (result == null) {
            throw new PackerRuntimeException("Cannot find msgField for this field: " + getPathRecursively(msgValue));
        }
        return result;
    }

    protected MsgField findInGraphRecurrently(MsgValue msgValue, MsgField msgField) {
        if (isValueBelongsToField(msgValue, msgField)) {
            return msgField;
        }
        if (msgField.getChildren() == null) {
            return null;
        }
        for (MsgField child : msgField.getChildren()) {
            MsgField nextResult = findInGraphRecurrently(msgValue, child);
            if (nextResult != null) {
                return nextResult;
            }
        }
        return null;
    }

    protected boolean isValueBelongsToField(MsgValue msgValue, MsgField msgField) {
        return Objects.equals(msgValue.getName(), msgField.getName()) &&
                Objects.equals(msgValue.getTag(), msgField.getTag());
    }

    @Override
    public MsgValue newFromNameAndTag(MsgField msgField) {
        MsgValue msgValue = new MsgValue();
        msgValue.setName(msgField.getName());
        msgValue.setTag(msgField.getTag());
        msgValue.setFieldNum(msgField.getFieldNum());
        return msgValue;
    }

    @Override
    public void validateSameNamesAndTags(MsgPair msgPair) {
        MsgField msgField = msgPair.getMsgField();
        MsgValue msgValue = msgPair.getMsgValue();
        boolean namesEqual = Objects.equals(msgValue.getName(), msgField.getName());
        boolean tagNumsEqual = Objects.equals(msgValue.getTag(), msgField.getTag());
        if (!namesEqual || !tagNumsEqual) {
            String cause;
            if (!namesEqual && !tagNumsEqual) {
                cause = "names and tags";
            } else if (!namesEqual) {
                cause = "names";
            } else {
                cause = "tags";
            }
            throw new PackerRuntimeException("The MsgField and its msgValue does not fit to each other because " +
                    "they have different " + cause + ".\nMsgValue: '" + getPathRecursively(msgValue) +
                    "'\nMsgField: '" + getPathRecursively(msgField) + "'\n" +
                    "Please navigate to a correct msgField by using the ValueHolder.adjust() or FieldBuilder.jump** methods.");
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public  T findByFieldNum(List msgList, Integer fieldNum) {
        if (fieldNum == null) {
            return null;
        }
        if (msgList == null) {
            return null;
        }
        for (Msg nextMsgField : msgList) {
            if (fieldNum.equals(nextMsgField.getFieldNum())) {
                return (T) nextMsgField;
            }
        }
        return null;
    }

    @Override
    public MsgValue synchronizeMessageValue(MsgField msgField, MsgValue msgValue) {
        if (Objects.equals(msgField.getName(), msgValue.getName()) &&
            Objects.equals(msgField.getTag(), msgValue.getTag()) &&
            msgField.getParent() == null && msgValue.getParent() == null) {
            return msgValue;
        }
        // root msgField
        if (msgField.getParent() == null) {
            return findRoot(msgValue);
        }
        String parentName = msgField.getParent().getName();
        Object parentTag = msgField.getParent().getTag();
        String name = msgField.getName();
        Object tag = msgField.getTag();
        return findInGraphRecurrently(parentName, parentTag, name, tag, findRoot(msgValue));
    }

    @SuppressWarnings("unchecked")
    private  T findInGraphRecurrently(String parentName, Object parentTag, String name, Object tag, T msg) {
        for (Msg child : msg.getChildren()) {
            if (Objects.equals(parentName, child.getParent().getName()) &&
                Objects.equals(parentTag, child.getParent().getTag()) &&
                Objects.equals(name, child.getName()) &&
                Objects.equals(tag, child.getName())) {
                return (T) child;
            }
            if (child.getChildren() != null) {
                return (T) findInGraphRecurrently(parentName, parentTag, name, tag, child);
            }
        }
        throw new PackerRuntimeException("Cannot find appropriate MsgValue with " +
            "parentName '" + parentName + "', " +
            "parentTag '" + parentTag + "', " +
            "name '" + name + "', " +
            "tag '" + tag + "' in the MsgField.");
    }

    /**
     * @param visualizer see the {@link #visualizer} field description.
     */
    @Override
    public void setVisualizer(Visualizer visualizer) {
        this.visualizer = visualizer;
    }
}