PropertyPath

  • PropertyPath represents a property path returned from searching the AppSearch Database.

  • It parses a string path like "foo.bar[0]" into a list of PathSegments, each representing a property and potentially an index.

  • This class focuses solely on parsing the path string and does not perform database retrievals, so the path may not be valid in the database.

  • PropertyPath has constructors for both a list of PathSegments and a path string, and provides methods to access, iterate, and get the size of the segments.
public class PropertyPath extends Object
implements Iterable<PropertyPath.PathSegment>

Represents a property path returned from searching the AppSearch Database.

One of the use cases for this class is when searching the AppSearch Database for the snippet matching use case. In this case you will get back SearchResult.MatchInfo objects that contain a property path signifying the location of a match within the database. This is a string that may look something like "foo.bar[0]". PropertyPath parses this string and breaks it up into a List of PropertyPath.PathSegments. These may represent either a property or a property and a 0-based index into the property. For instance, "foo.bar[1]" would be parsed into a PropertyPath.PathSegment with a property name of foo and a PropertyPath.PathSegment with a property name of bar and an index of 1. This allows for easier manipulation of the property path.

This class won't perform any retrievals, it will only parse the path string. As such, it may not necessarily refer to a valid path in the database.

See Also

Nested Class Summary

class PropertyPath.PathSegment A segment of a PropertyPath, which includes the name of the property and a 0-based index into this property. 

Public Constructor Summary

PropertyPath(List<PropertyPath.PathSegment> pathList)
Constructor directly accepting a path list
PropertyPath(String path)
Constructor that parses a string representing the path to populate a List of PathSegments

Public Method Summary

boolean
equals(Object o)
PropertyPath.PathSegment
get(int index)
Returns the PropertyPath.PathSegment at a specified index of the PropertyPath.
int
hashCode()
Iterator<PropertyPath.PathSegment>
iterator()
Returns an iterator over the PathSegments within the PropertyPath
int
size()
Returns the number of PropertyPath.PathSegments in the PropertyPath.
String
toString()
Returns a valid path string representing this PropertyPath

Inherited Method Summary

Public Constructors

public PropertyPath (List<PropertyPath.PathSegment> pathList)

Constructor directly accepting a path list

Parameters
pathList a list of PathSegments

public PropertyPath (String path)

Constructor that parses a string representing the path to populate a List of PathSegments

Parameters
path the string to be validated and parsed into PathSegments
Throws
IllegalArgumentException when the path is invalid or malformed

Public Methods

public boolean equals (Object o)

public PropertyPath.PathSegment get (int index)

Returns the PropertyPath.PathSegment at a specified index of the PropertyPath.

Calling get(1) on a PropertyPath representing "foo.bar[1]" will return a PropertyPath.PathSegment representing "bar[1]". PropertyPath.PathSegments both with and without a property index of PropertyPath.PathSegment.NON_REPEATED_CARDINALITY are retrieved the same.

Parameters
index the position into the PropertyPath
Throws
ArrayIndexOutOfBoundsException if index is not a valid index in the path list

public int hashCode ()

public Iterator<PropertyPath.PathSegment> iterator ()

Returns an iterator over the PathSegments within the PropertyPath

public int size ()

Returns the number of PropertyPath.PathSegments in the PropertyPath.

Paths representing "foo.bar" and "foo[1].bar[1]" will have the same size, as a property and an index into that property are stored in one PropertyPath.PathSegment.

public String toString ()

Returns a valid path string representing this PropertyPath