net.minidev.json.actions.traverse.LocatePathsJsonAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of json-smart-action Show documentation

JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. It is based on a subset of the JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, Python, and many others. These properties make JSON an ideal data-interchange language.

There is a newer version: 2.5.1

Show newest version

package net.minidev.json.actions.traverse;

import net.minidev.json.JSONArray;
import net.minidev.json.JSONObject;
import net.minidev.json.actions.path.PathDelimiter;

import java.util.LinkedList;
import java.util.List;
import java.util.Map.Entry;

/**
 * Searches for paths in a {@link JSONObject} and returns those found
 * 
 * A path is not removed from the user-specified list once its processing is over,
 * because identical objects in the same array are supported by this action.
 * 

 * See package-info for more details
 * 
 * See unit tests for examples
 *
 * @author [email protected]
 *
 */
public class LocatePathsJsonAction implements JSONTraverseAction {
	protected List pathsFound;
	protected List pathsToFind;
	protected PathDelimiter delim;

	/**
	 *
	 * @param pathsToFind
	 *            A path to a field in the {@link JSONObject} should be specified in n-gram format where keys are chained: k0[[[.k1].k2]...]
	 * @param delim -
	 */
	public LocatePathsJsonAction(List pathsToFind, PathDelimiter delim) {
		this.pathsToFind = pathsToFind;
		this.delim = delim;
		pathsFound = new LinkedList();
	}

	@Override
	public boolean start(JSONObject object) {
		return object != null && pathsToFind != null && pathsToFind.size() > 0;
	}

	@Override
	public boolean traverseEntry(String fullPathToEntry, Entry entry) {
		if (!delim.accept(entry.getKey())) {
			return false;
		}
		locatePath(fullPathToEntry);
		return true;
	}

	@Override
	public boolean recurInto(String pathToEntry, JSONObject entryValue) {
		return true;
	}

	@Override
	public boolean recurInto(String pathToEntry, JSONArray entryValue) {
		return true;
	}

	@Override
	public void handleLeaf(String pathToEntry, Entry entry) {

	}

	@Override
	public void handleLeaf(String fullPathToContainingList, int listIndex, Object listItem) {

	}

	@Override
	public boolean removeEntry(String fullPathToEntry, Entry entry) {
		return false;
	}

	@Override
	public void end() {
		// nothing to do
	}

	@Override
	public Object result() {
		return pathsFound;
	}

	private void locatePath(String pathToEntry) {
		if (pathsToFind.contains(pathToEntry)) {
			// reached end of path that is being searched
			pathsFound.add(pathToEntry);
		}
	}
}