com.viaoa.util

Class OAPropertyPath<F>

java.lang.Object

com.viaoa.util.OAPropertyPath<F>

Type Parameters:

F - type of object that the property path is based on.

public class OAPropertyPath<F>
extends Object

Utility used to parse a propertyPath, get methods, class information, and to be able to get the value by invoking on an object. A PropertyPath String is separated by "." for each linkPropery, and each linkProperty can have a filter in the format ":filterName(a,b,n)" Supports casting in property path, ex: from Emp, "dept.(manager)employee.name" ex: from OALeftJoin "(Location)A.name" Supports filters: ex: "dept.employees:newHires(7).orders.orderItems:overDue(30)" Recursive: created 20120809

See Also:

which uses propertyPaths to create a Hub of all lastNode objects, and keeps it updated., OAPropertyPathDelegate

Constructor Summary

Constructors

Constructor and Description
OAPropertyPath(Class<F> fromClass, String propertyPath)
OAPropertyPath(Class<F> fromClass, String propertyPath, boolean bIgnoreError)
OAPropertyPath(String propertyPath)

Method Summary

Modifier and Type	Method and Description
String[]	getCastNames()
Class[]	getClasses()
boolean	getDoesLastMethodHasHubParam()
OACalcInfo	getEndCalcInfo()
OALinkInfo	getEndLinkInfo()
OAPropertyInfo	getEndPropertyInfo()
Constructor[]	getFilterConstructors()
String[]	getFilterNames()
String[]	getFilterParams()
Object[][]	getFilterParamValues()
String	getFirstPropertyName()
String	getFormat()
Class<F>	getFromClass()
boolean	getHasHubProperty()
Object	getLastLinkValue(F fromObject)
String	getLastPropertyName()
OALinkInfo[]	getLinkInfos()
Method[]	getMethods()
boolean	getNeedsDataToVerify()
OACalculatedProperty	getOACalculatedPropertyAnnotation()
OAOne	getOAOneAnnotation()
OAProperty	getOAPropertyAnnotation()
String[]	getProperties()
String	getPropertyPath()
String	getPropertyPathLinksOnly()
OALinkInfo[]	getRecursiveLinkInfos()
OAPropertyPath	getReversePropertyPath()
OAPropertyPath	getReversePropertyPath(boolean bAllowPrivateLinks)
Object	getValue(F fromObject)
Object	getValue(Hub<F> hub, F fromObject) Returns the value of the propertyPath from a base object.
Object	getValue(Hub<F> hub, F fromObject, boolean bLinksOnly)
Object	getValue(OAObject fromObject, int startPos) Used when fromObject is already in the propertyPath.
String	getValueAsString(F fromObject)
String	getValueAsString(Hub<F> hub, F fromObject) This will call getValue, and then call OAConv.toString using getFormat.
String	getValueAsString(Hub<F> hub, F fromObject, String format)
boolean	hasLinks()
boolean	hasPrivateLink()
void	setup(Class clazz)
void	setup(Class clazz, boolean bIgnorePrivateLink)
void	setup(Hub hub)
String	setup(Hub hub, Class clazz, boolean bIgnorePrivateLink)
String	setup(Hub hub, Class clazz, Class substituteClass, boolean bIgnorePrivateLink)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAPropertyPath

public OAPropertyPath(String propertyPath)

OAPropertyPath

public OAPropertyPath(Class<F> fromClass,
                      String propertyPath)

OAPropertyPath

public OAPropertyPath(Class<F> fromClass,
                      String propertyPath,
                      boolean bIgnoreError)

Method Detail

getPropertyPath

public String getPropertyPath()

getReversePropertyPath

public OAPropertyPath getReversePropertyPath()

getReversePropertyPath

public OAPropertyPath getReversePropertyPath(boolean bAllowPrivateLinks)

getPropertyPathLinksOnly

public String getPropertyPathLinksOnly()

getEndPropertyInfo

public OAPropertyInfo getEndPropertyInfo()

getEndCalcInfo

public OACalcInfo getEndCalcInfo()

getEndLinkInfo

public OALinkInfo getEndLinkInfo()

getOAPropertyAnnotation

public OAProperty getOAPropertyAnnotation()

getOACalculatedPropertyAnnotation

public OACalculatedProperty getOACalculatedPropertyAnnotation()

getOAOneAnnotation

public OAOne getOAOneAnnotation()

getProperties

public String[] getProperties()

getCastNames

public String[] getCastNames()

getFilterNames

public String[] getFilterNames()

getFilterParams

public String[] getFilterParams()

getFilterParamValues

public Object[][] getFilterParamValues()

getMethods

public Method[] getMethods()

getClasses

public Class[] getClasses()

getFilterConstructors

public Constructor[] getFilterConstructors()

getLinkInfos

public OALinkInfo[] getLinkInfos()

hasLinks

public boolean hasLinks()

getRecursiveLinkInfos

public OALinkInfo[] getRecursiveLinkInfos()

getValue

public Object getValue(F fromObject)

getValueAsString

public String getValueAsString(F fromObject)

getLastLinkValue

public Object getLastLinkValue(F fromObject)

getLastPropertyName

public String getLastPropertyName()

getFirstPropertyName

public String getFirstPropertyName()

getValue

public Object getValue(Hub<F> hub,
                       F fromObject)

Returns the value of the propertyPath from a base object. Notes: if any of the property's is null, then null is returned. If any of the non-last properties is a Hub, then the AO will be used.

getValue

public Object getValue(Hub<F> hub,
                       F fromObject,
                       boolean bLinksOnly)

getValueAsString

public String getValueAsString(Hub<F> hub,
                               F fromObject)

This will call getValue, and then call OAConv.toString using getFormat.

getValueAsString

public String getValueAsString(Hub<F> hub,
                               F fromObject,
                               String format)

getFromClass

public Class<F> getFromClass()

setup

public void setup(Hub hub)

setup

public void setup(Class clazz)

setup

public void setup(Class clazz,
                  boolean bIgnorePrivateLink)

hasPrivateLink

public boolean hasPrivateLink()

getDoesLastMethodHasHubParam

public boolean getDoesLastMethodHasHubParam()

getNeedsDataToVerify

public boolean getNeedsDataToVerify()

setup

public String setup(Hub hub,
                    Class clazz,
                    boolean bIgnorePrivateLink)

setup

public String setup(Hub hub,
                    Class clazz,
                    Class substituteClass,
                    boolean bIgnorePrivateLink)

Parameters:

substituteClass - class to use if a link property is of type OAObject.class

bIgnorePrivateLink - if true, then a link that does not have a get method will not throw an exception. Used by HubGroupBy

getFormat

public String getFormat()

getHasHubProperty

public boolean getHasHubProperty()

getValue

public Object getValue(OAObject fromObject,
                       int startPos)

Used when fromObject is already in the propertyPath.

Parameters:

fromObject - object to start with

startPos - number of properties to skip in the PP, that aligns with fromObject's position in the PP.