Java StackFrameStep类代码示例

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
@Before
public void setUp() {
    mSandbox = new PersistableSandbox();

    commandIdStepV1 = new StackFrameStep(SessionFrame.STATE_COMMAND_ID, "id", null);
    commandIdStepV2 = new StackFrameStep(SessionFrame.STATE_COMMAND_ID, "id", null);

    caseIdStepV1 = new StackFrameStep(SessionFrame.STATE_DATUM_VAL, "id", "case_val");
    caseIdStepV2 = new StackFrameStep(SessionFrame.STATE_DATUM_VAL, "id", null);

    formXmlnsStepV1 = new StackFrameStep(SessionFrame.STATE_FORM_XMLNS, "xmlns_id1", null);
    formXmlnsStepV2 = new StackFrameStep(SessionFrame.STATE_FORM_XMLNS, "xmlns_id2", null);

    datumComputedStepV1 = new StackFrameStep(SessionFrame.STATE_DATUM_COMPUTED, "datum_val_id", "datum_val1");
    datumComputedStepV2 = new StackFrameStep(SessionFrame.STATE_DATUM_COMPUTED, "datum_val_id", "datum_val2");

    // frame steps can store externalizable data, such as ints, Strings,
    // or anything that implements Externalizable
    stepWithExtras = new StackFrameStep(SessionFrame.STATE_DATUM_COMPUTED, "datum_val_id", "datum_val2");
    stepWithExtras.addExtra("key", 123);

    // Demonstrate how frame steps can't store non-externalizable data in extras
    stepWithBadExtras = new StackFrameStep(SessionFrame.STATE_DATUM_COMPUTED, "datum_val_id", "datum_val2");
    stepWithBadExtras.addExtra("key", new ByteArrayInputStream(new byte[]{1,2,3}));
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
@Test
public void serializationTest() {
    byte[] serializedStep = mSandbox.serialize(commandIdStepV1);
    StackFrameStep deserialized = mSandbox.deserialize(serializedStep, StackFrameStep.class);
    assertTrue("Serialization resulted in altered StackFrameStep",
            commandIdStepV1.equals(deserialized));

    serializedStep = mSandbox.serialize(stepWithExtras);
    deserialized = mSandbox.deserialize(serializedStep, StackFrameStep.class);
    assertTrue("",
            stepWithExtras.equals(deserialized));

    boolean failed = false;
    try {
        mSandbox.serialize(stepWithBadExtras);
    } catch (Exception e) {
        failed = true;
    }
    assertTrue(failed);
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
/**
 * Copy constructor
 */
public CommCareSession(CommCareSession oldCommCareSession) {
    // NOTE: 'platform' is being copied in a shallow manner
    this.platform = oldCommCareSession.platform;

    if (oldCommCareSession.popped != null) {
        this.popped = new StackFrameStep(oldCommCareSession.popped);
    }
    this.currentCmd = oldCommCareSession.currentCmd;
    this.currentXmlns = oldCommCareSession.currentXmlns;
    this.frame = new SessionFrame(oldCommCareSession.frame);

    collectedDatums = new OrderedHashtable<String, String>();
    for (Enumeration e = oldCommCareSession.collectedDatums.keys(); e.hasMoreElements(); ) {
        String key = (String)e.nextElement();
        collectedDatums.put(key, oldCommCareSession.collectedDatums.get(key));
    }

    this.frameStack = new Stack<SessionFrame>();
    // NOTE: can't use for/each due to J2ME build issues w/ Stack
    for (int i = 0; i < oldCommCareSession.frameStack.size(); i++) {
        frameStack.addElement(oldCommCareSession.frameStack.elementAt(i));
    }
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
private void syncState() {
    this.collectedDatums.clear();
    this.currentCmd = null;
    this.currentXmlns = null;
    this.popped = null;

    for (StackFrameStep step : frame.getSteps()) {
        if (SessionFrame.STATE_DATUM_VAL.equals(step.getType())) {
            String key = step.getId();
            String value = step.getValue();
            if (key != null && value != null) {
                collectedDatums.put(key, value);
            }
        } else if (SessionFrame.STATE_QUERY_REQUEST.equals(step.getType())) {
            collectedDatums.put(step.getId(), step.getValue());
        } else if (SessionFrame.STATE_COMMAND_ID.equals(step.getType())) {
            this.currentCmd = step.getId();
        } else if (SessionFrame.STATE_FORM_XMLNS.equals(step.getType())) {
            this.currentXmlns = step.getId();
        }
    }
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
private StackFrameStep parseValue(String type, String datumId) throws XmlPullParserException, IOException, InvalidStructureException {
    //TODO: ... require this to have a value!!!! It's not processing this properly
    String value = parser.getAttributeValue(null, "value");
    boolean valueIsXpath;
    if (value == null) {
        //must have a child
        value = parser.nextText();
        //Can we get here, or would this have caused an exception?
        if (value == null) {
            throw new InvalidStructureException("Stack frame element must define a value expression or have a direct value", parser);
        } else {
            value = value.trim();
        }
        valueIsXpath = false;
    } else {
        //parse out the xpath value to double check for errors
        valueIsXpath = true;
    }
    try {
        return new StackFrameStep(type, datumId, value, valueIsXpath);
    } catch (XPathSyntaxException e) {
        throw new InvalidStructureException("Invalid expression for stack frame step definition: " + value + ".\n" + e.getMessage(), parser);
    }
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
private Pair<View, TreeReference> buildContextTile(StackFrameStep stepToFrame, AndroidSessionWrapper asw) {
    if (stepToFrame == null) {
        return null;
    }

    //check to make sure we can look up this child
    EntityDatum entityDatum = asw.getSession().findDatumDefinition(stepToFrame.getId());
    if (entityDatum == null || entityDatum.getPersistentDetail() == null) {
        return null;
    }

    //Make sure there is a valid reference to the entity we can build
    Detail detail = asw.getSession().getDetail(entityDatum.getPersistentDetail());

    EvaluationContext ec = asw.getEvaluationContext();

    TreeReference ref = entityDatum.getEntityFromID(ec, stepToFrame.getValue());
    if (ref == null) {
        return null;
    }

    Pair<View, TreeReference> r = buildContextTile(detail, ref, asw);
    r.first.setTag(entityDatum.getInlineDetail());
    return r;
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
/**
 * Serializes the session into a string which is unique for a
 * given path through the application, and which can be deserialzied
 * back into a live session.
 *
 * NOTE: Currently we rely on this state being semantically unique,
 * but it may change in the future. Rely on the specific format as
 * little as possible.
 */
public static String createSessionDescriptor(CommCareSession session) {
    StringBuilder descriptor = new StringBuilder();
    for (StackFrameStep step : session.getFrame().getSteps()) {
        String type = step.getType();
        if (SessionFrame.STATE_QUERY_REQUEST.equals(type) ||
                SessionFrame.STATE_SYNC_REQUEST.equals(type)) {
            // Skip adding remote server query/sync steps to the descriptor.
            // They are hard to replay (requires serializing query results)
            // and shouldn't be needed for incomplete forms
            continue;
        }
        descriptor.append(type).append(" ");
        if (SessionFrame.STATE_COMMAND_ID.equals(type)) {
            descriptor.append(step.getId()).append(" ");
        } else if (SessionFrame.STATE_DATUM_VAL.equals(type)
                || SessionFrame.STATE_DATUM_COMPUTED.equals(type)) {
            descriptor.append(step.getId()).append(" ").append(step.getValue()).append(" ");
        }
    }
    return descriptor.toString().trim();
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
/**
 * Copy constructor
 */
public CommCareSession(CommCareSession oldCommCareSession) {
    // NOTE: 'platform' is being copied in a shallow manner
    this.platform = oldCommCareSession.platform;

    if (oldCommCareSession.popped != null) {
        this.popped = new StackFrameStep(oldCommCareSession.popped);
    }
    this.currentCmd = oldCommCareSession.currentCmd;
    this.currentXmlns = oldCommCareSession.currentXmlns;
    this.frame = new SessionFrame(oldCommCareSession.frame);

    collectedDatums = new OrderedHashtable<>();
    for (Enumeration e = oldCommCareSession.collectedDatums.keys(); e.hasMoreElements(); ) {
        String key = (String)e.nextElement();
        collectedDatums.put(key, oldCommCareSession.collectedDatums.get(key));
    }

    this.frameStack = new Stack<>();
    // NOTE: can't use for/each due to J2ME build issues w/ Stack
    for (int i = 0; i < oldCommCareSession.frameStack.size(); i++) {
        frameStack.addElement(oldCommCareSession.frameStack.elementAt(i));
    }
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
/**
 * When StackFrameSteps are parsed, those that are "datum" operations will be marked as type
 * "unknown". When we encounter a StackFrameStep of unknown type at runtime, we need to
 * determine whether it should be interpreted as STATE_DATUM_COMPUTED, STATE_COMMAND_ID,
 * or STATE_DATUM_VAL This primarily affects the behavior of stepBack().
 *
 * The logic being employed is: If there is a previous step on the stack whose entries would
 * have added this command, interpret it as a command. If there is an EntityDatum that
 * was have added this as an entity selection, interpret this as a datum_val. O
 * Otherwise, interpret it as a computed datum.
 */
private String guessUnknownType(StackFrameStep popped) {
    String poppedId = popped.getId();
    for (StackFrameStep stackFrameStep : frame.getSteps()) {
        String commandId = stackFrameStep.getId();
        Vector<Entry> entries = getEntriesForCommand(commandId);
        for (Entry entry : entries) {
            String childCommand = entry.getCommandId();
            if (childCommand.equals(poppedId)) {
                return SessionFrame.STATE_COMMAND_ID;
            }
            Vector<SessionDatum> data = entry.getSessionDataReqs();
            for (SessionDatum datum : data) {
                if (datum instanceof EntityDatum &&
                        datum.getDataId().equals(poppedId)) {
                    return SessionFrame.STATE_DATUM_VAL;
                }
            }
        }
    }
    return SessionFrame.STATE_DATUM_COMPUTED;
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
public void syncState() {
    this.collectedDatums.clear();
    this.currentCmd = null;
    this.currentXmlns = null;
    this.popped = null;

    for (StackFrameStep step : frame.getSteps()) {
        if (SessionFrame.STATE_DATUM_VAL.equals(step.getType()) ||
                SessionFrame.STATE_DATUM_COMPUTED.equals(step.getType()) ||
                SessionFrame.STATE_UNKNOWN.equals(step.getType()) &&
                        (guessUnknownType(step).equals(SessionFrame.STATE_DATUM_COMPUTED)
                        || guessUnknownType(step).equals(SessionFrame.STATE_DATUM_VAL))) {
            String key = step.getId();
            String value = step.getValue();
            if (key != null && value != null) {
                collectedDatums.put(key, value);
            }
        } else if (SessionFrame.STATE_QUERY_REQUEST.equals(step.getType())) {
            collectedDatums.put(step.getId(), step.getValue());
        } else if (SessionFrame.STATE_COMMAND_ID.equals(step.getType())) {
            this.currentCmd = step.getId();
        } else if (SessionFrame.STATE_FORM_XMLNS.equals(step.getType())) {
            this.currentXmlns = step.getId();
        }
    }
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
@Override
public StackFrameStep parse() throws InvalidStructureException, IOException, XmlPullParserException {
    String operation = parser.getName();

    switch (operation) {
        case "datum":
            String id = parser.getAttributeValue(null, "id");
            return parseValue(SessionFrame.STATE_UNKNOWN, id);
        case "rewind":
            return parseValue(SessionFrame.STATE_REWIND, null);
        case "mark":
            return parseValue(SessionFrame.STATE_MARK, null);
        case "command":
            return parseValue(SessionFrame.STATE_COMMAND_ID, null);
        default:
            throw new InvalidStructureException("<" + operation + "> is not a valid stack frame element!", this.parser);
    }
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
private void printStack(SessionWrapper mSession) {
    SessionFrame frame = mSession.getFrame();
    System.out.println("Live Frame" + (frame.getFrameId() == null ? "" : " [" + frame.getFrameId() + "]"));
    System.out.println("----------");
    for (StackFrameStep step : frame.getSteps()) {
        if (step.getType().equals(SessionFrame.STATE_COMMAND_ID)) {
            System.out.println("COMMAND: " + step.getId());
        } else {
            System.out.println("DATUM : " + step.getId() + " - " + step.getValue());
        }
    }
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
public String[] getHeaderTitles() {
    Hashtable<String, String> menus = new Hashtable<String, String>();

    for (Suite s : platform.getInstalledSuites()) {
        for (Menu m : s.getMenus()) {
            menus.put(m.getId(), m.getName().evaluate());
        }
    }

    Vector<StackFrameStep> steps = frame.getSteps();
    String[] returnVal = new String[steps.size()];

    Hashtable<String, Entry> entries = platform.getMenuMap();
    int i = 0;
    for (StackFrameStep step : steps) {
        if (SessionFrame.STATE_COMMAND_ID.equals(step.getType())) {
            //Menu or form.
            if (menus.containsKey(step.getId())) {
                returnVal[i] = menus.get(step.getId());
            } else if (entries.containsKey(step.getId())) {
                returnVal[i] = entries.get(step.getId()).getText().evaluate();
            }
        } else if (SessionFrame.STATE_DATUM_VAL.equals(step.getType())) {
            //TODO: Grab the name of the case
        } else if (SessionFrame.STATE_DATUM_COMPUTED.equals(step.getType())) {
            //Nothing to do here
        }

        if (returnVal[i] != null) {
            //Menus contain a potential argument listing where that value is on the screen,
            //clear it out if it exists
            returnVal[i] = Localizer.processArguments(returnVal[i], new String[]{""}).trim();
        }

        ++i;
    }

    return returnVal;
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
/**
 * Set a (xml) data instance as the result to a session query datum.
 * The instance is available in session's evaluation context until the corresponding query frame is removed
 */
public void setQueryDatum(ExternalDataInstance queryResultInstance) {
    SessionDatum datum = getNeededDatum();
    if (datum instanceof RemoteQueryDatum) {
        StackFrameStep step =
                new StackFrameStep(SessionFrame.STATE_QUERY_REQUEST,
                        datum.getDataId(), datum.getValue(), queryResultInstance);
        frame.pushStep(step);
        syncState();
    } else {
        throw new RuntimeException("Trying to set query successful when one isn't needed.");
    }
}
 

import org.commcare.suite.model.StackFrameStep; //导入依赖的package包/类
private void addInstancesFromFrame(Hashtable<String, DataInstance> instanceMap) {
    for (StackFrameStep step : frame.getSteps()) {
        if (step.hasXmlInstance()) {
            instanceMap.put(step.getId(), step.getXmlInstance());
        }
    }
}