OAObjectInfo (OA Java Code Documentation)

java.lang.Object
- com.viaoa.object.OAObjectInfo

```
public class OAObjectInfo
extends Object
```
OAObjectInfo contains information about an OAObject. This includes object id, links to other objects, calculated properties.
For more information about this package, see documentation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class OAObjectInfo.TriggerInfo
June 2016 triggers when a property/hub is changed.

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`OAObjectInfo.TriggerInfo` June 2016 triggers when a property/hub is changed.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArrayList<OACalcInfo>`	`alCalcInfo`
`protected List<OALinkInfo>`	`alLinkInfo`
`protected ArrayList<OAMethodInfo>`	`alMethodInfo`
`protected ArrayList<OAPropertyInfo>`	`alPropertyInfo`
`protected boolean`	`bAddToCache`
`protected boolean`	`bInitializeNewObjects`
`protected boolean`	`bLocalOnly`
`protected boolean`	`bLookup`
`protected boolean`	`bPreSelect`
`protected boolean`	`bProcessed`
`protected boolean`	`bSetLinkToOwner`
`protected boolean`	`bSetRecursive`
`protected boolean`	`bUseDataSource`
`protected String`	`displayName`
`protected ConcurrentHashMap<String,CopyOnWriteArrayList<OAObjectInfo.TriggerInfo>>`	`hmTriggerInfo`
`protected HashSet<String>`	`hsHubCalcInfoName`
`protected String[]`	`hubProps`
`protected String[]`	`idProperties`
`protected String[]`	`importMatchProperties`
`protected OALinkInfo`	`liLinkToOwner`
`protected OALinkInfo`	`liRecursiveMany`
`protected OALinkInfo`	`liRecursiveOne`
`protected byte[]`	`primitiveMask`
`protected String[]`	`primitiveProps`
`protected String[]`	`rootTreePropertyPaths`
`protected Class`	`thisClass`

Constructor Summary

Constructors
Constructor and Description

OAObjectInfo()

OAObjectInfo(String objectIdProperty)

OAObjectInfo(String[] idProperties)

Constructors
Constructor and Description
`OAObjectInfo()`
`OAObjectInfo(String objectIdProperty)`
`OAObjectInfo(String[] idProperties)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_removeTrigger(OATrigger trigger)`
`void`	`addCalc(OACalcInfo ci)`
`void`	`addCalcInfo(OACalcInfo ci)`
`void`	`addEditQueryMethod(String name, Method m)`
`void`	`addLink(OALinkInfo li)`
`void`	`addLinkInfo(OALinkInfo li)`
`void`	`addMethod(OAMethodInfo mi)`
`void`	`addMethodInfo(OAMethodInfo mi)`
`void`	`addProperty(OAPropertyInfo ci)`
`void`	`addPropertyInfo(OAPropertyInfo ci)`
`void`	`addRequired(String prop)`
`protected void`	`createTrigger(OATrigger trigger, boolean bSkipFirstNonManyProperty)` Not called directly, but used by OATriggerDelegate.createTrigger(..) to create, register and call a trigger.
`boolean`	`getAddToCache()`
`OACalcInfo`	`getCalcInfo(String s)`
`ArrayList<OACalcInfo>`	`getCalcInfos()`
`String[]`	`getContextDependentProperties()`
`String`	`getContextEnabledProperty()`
`boolean`	`getContextEnabledValue()`
`String`	`getContextVisibleProperty()`
`boolean`	`getContextVisibleValue()`
`String`	`getDisplayName()`
`Method`	`getEditQueryMethod()`
`Method`	`getEditQueryMethod(String name)`
`String`	`getEnabledProperty()`
`boolean`	`getEnabledValue()`
`Class`	`getForClass()`
`boolean`	`getHasTriggers()`
`String[]`	`getHubProperties()` used to set which primitive properties should be set to null for new instances.
`String[]`	`getIdProperties()`
`String[]`	`getImportMatchProperties()`
`boolean`	`getInitializeNewObjects()`
`OALinkInfo`	`getLinkInfo(String propertyName)`
`List<OALinkInfo>`	`getLinkInfos()`
`boolean`	`getLocalOnly()`
`boolean`	`getLookup()`
`OAMethodInfo`	`getMethodInfo(String name)`
`ArrayList<OAMethodInfo>`	`getMethodInfos()`
`OALinkInfo`	`getOwnedByOne()`
`OALinkInfo[]`	`getOwnedLinkInfos()`
`boolean`	`getPreSelect()`
`String[]`	`getPrimitiveProperties()`
`boolean`	`getProcessed()`
`OAPropertyInfo`	`getPropertyInfo(String propertyName)`
`ArrayList<OAPropertyInfo>`	`getPropertyInfos()` This is for regular properties, and does not include reference properties.
`OALinkInfo`	`getRecursiveLinkInfo(int type)`
`String[]`	`getRootTreePropertyPaths()`
`boolean`	`getSupportsStorage()`
`OAPropertyInfo`	`getTimestampProperty()`
`static int`	`getTotalTriggers()` total triggers created.
`ArrayList<String>`	`getTriggerPropertNames()`
`ArrayList<OATrigger>`	`getTriggers(String propertyName)`
`boolean`	`getUseDataSource()`
`String[]`	`getViewDependentProperties()`
`String`	`getVisibleProperty()`
`boolean`	`getVisibleValue()`
`boolean`	`hasImportMatchProperties()`
`boolean`	`isHubCalcInfo(String name)`
`boolean`	`isIdProperty(String prop)`
`boolean`	`isOwnedAndNoReverseMany()`
`void`	`onChange(OAObject fromObject, String prop, HubEvent hubEvent)` called by OAObject.propChange, Hub.add/remove/removeAll/insert, and OAObjectCacheDelegate when a change is made.
`void`	`removeTrigger(OATrigger trigger)`
`void`	`setAddToCache(boolean b)`
`void`	`setContextDependentProperties(String[] ss)`
`void`	`setContextEnabledProperty(String s)`
`void`	`setContextEnabledValue(boolean b)`
`void`	`setContextVisibleProperty(String s)`
`void`	`setContextVisibleValue(boolean b)`
`void`	`setDisplayName(String s)`
`void`	`setEditQueryMethod(Method m)`
`void`	`setEnabledProperty(String s)`
`void`	`setEnabledValue(boolean b)`
`void`	`setInitializeNewObjects(boolean b)`
`void`	`setLocalOnly(boolean b)`
`void`	`setLookup(boolean b)`
`void`	`setPreSelect(boolean b)`
`void`	`setProcessed(boolean b)`
`void`	`setRootTreePropertyPaths(String[] paths)`
`void`	`setUseDataSource(boolean b)`
`void`	`setViewDependentProperties(String[] ss)`
`void`	`setVisibleProperty(String s)`
`void`	`setVisibleValue(boolean b)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

thisClass
```
protected Class thisClass
```

alLinkInfo
```
protected List<OALinkInfo> alLinkInfo
```

alCalcInfo

protected ArrayList<OACalcInfo> alCalcInfo

hsHubCalcInfoName

protected HashSet<String> hsHubCalcInfoName

idProperties
```
protected String[] idProperties
```

importMatchProperties

protected String[] importMatchProperties

alPropertyInfo

protected ArrayList<OAPropertyInfo> alPropertyInfo

alMethodInfo

protected ArrayList<OAMethodInfo> alMethodInfo

bUseDataSource
```
protected boolean bUseDataSource
```

bLocalOnly
```
protected boolean bLocalOnly
```

bAddToCache
```
protected boolean bAddToCache
```

bInitializeNewObjects

protected boolean bInitializeNewObjects

displayName
```
protected String displayName
```

rootTreePropertyPaths

protected String[] rootTreePropertyPaths

primitiveProps
```
protected String[] primitiveProps
```

primitiveMask
```
protected byte[] primitiveMask
```

hubProps
```
protected String[] hubProps
```

bSetRecursive

protected volatile boolean bSetRecursive

liRecursiveOne
```
protected OALinkInfo liRecursiveOne
```

liRecursiveMany
```
protected OALinkInfo liRecursiveMany
```

bSetLinkToOwner

protected volatile boolean bSetLinkToOwner

liLinkToOwner
```
protected OALinkInfo liLinkToOwner
```

bProcessed
```
protected boolean bProcessed
```

bLookup
```
protected boolean bLookup
```

hmTriggerInfo

protected ConcurrentHashMap<String,CopyOnWriteArrayList<OAObjectInfo.TriggerInfo>> hmTriggerInfo

bPreSelect
```
protected boolean bPreSelect
```

Constructor Detail

OAObjectInfo
```
public OAObjectInfo()
```

OAObjectInfo

public OAObjectInfo(String objectIdProperty)

OAObjectInfo

public OAObjectInfo(String[] idProperties)

Method Detail

getForClass
```
public Class getForClass()
```

getIdProperties
```
public String[] getIdProperties()
```

isIdProperty

public boolean isIdProperty(String prop)

hasImportMatchProperties

public boolean hasImportMatchProperties()

getImportMatchProperties

public String[] getImportMatchProperties()

getLinkInfos

public List<OALinkInfo> getLinkInfos()

addLink
```
public void addLink(OALinkInfo li)
```

addLinkInfo

public void addLinkInfo(OALinkInfo li)

getLinkInfo

public OALinkInfo getLinkInfo(String propertyName)

getOwnedLinkInfos

public OALinkInfo[] getOwnedLinkInfos()

isOwnedAndNoReverseMany

public boolean isOwnedAndNoReverseMany()

getOwnedByOne
```
public OALinkInfo getOwnedByOne()
```

getCalcInfos

public ArrayList<OACalcInfo> getCalcInfos()

getCalcInfo

public OACalcInfo getCalcInfo(String s)

addCalc
```
public void addCalc(OACalcInfo ci)
```

addCalcInfo

public void addCalcInfo(OACalcInfo ci)

isHubCalcInfo

public boolean isHubCalcInfo(String name)

getPropertyInfos
```
public ArrayList<OAPropertyInfo> getPropertyInfos()
```
This is for regular properties, and does not include reference properties.

See Also:

to get list of reference properties.

addProperty

public void addProperty(OAPropertyInfo ci)

addPropertyInfo

public void addPropertyInfo(OAPropertyInfo ci)

getPropertyInfo

public OAPropertyInfo getPropertyInfo(String propertyName)

getMethodInfos

public ArrayList<OAMethodInfo> getMethodInfos()

addMethod

public void addMethod(OAMethodInfo mi)

addMethodInfo

public void addMethodInfo(OAMethodInfo mi)

getMethodInfo

public OAMethodInfo getMethodInfo(String name)

getEditQueryMethod

public Method getEditQueryMethod(String name)

addEditQueryMethod

public void addEditQueryMethod(String name,
                               Method m)

getPrimitiveProperties

public String[] getPrimitiveProperties()

getHubProperties
```
public String[] getHubProperties()
```
used to set which primitive properties should be set to null for new instances. boolean props will not be set to null.

Returns:

/ public byte[] getPrimitiveMask() { if (primitiveMask != null) return primitiveMask; String[] ps = getPrimitiveProperties(); int x = (ps==null) ? 0 : ((int) Math.ceil(ps.length / 8.0d)); primitiveMask = new byte[x]; for (int i=0; i

setUseDataSource

public void setUseDataSource(boolean b)

getUseDataSource
```
public boolean getUseDataSource()
```

setLocalOnly
```
public void setLocalOnly(boolean b)
```

getLocalOnly
```
public boolean getLocalOnly()
```

setAddToCache
```
public void setAddToCache(boolean b)
```

getAddToCache
```
public boolean getAddToCache()
```

setInitializeNewObjects

public void setInitializeNewObjects(boolean b)

getInitializeNewObjects

public boolean getInitializeNewObjects()

getDisplayName
```
public String getDisplayName()
```

setDisplayName
```
public void setDisplayName(String s)
```

getRootTreePropertyPaths

public String[] getRootTreePropertyPaths()

setRootTreePropertyPaths

public void setRootTreePropertyPaths(String[] paths)

addRequired
```
public void addRequired(String prop)
```

getRecursiveLinkInfo

public OALinkInfo getRecursiveLinkInfo(int type)

getSupportsStorage
```
public boolean getSupportsStorage()
```

getTotalTriggers
```
public static int getTotalTriggers()
```
total triggers created.

getTriggerPropertNames

public ArrayList<String> getTriggerPropertNames()

createTrigger
```
protected void createTrigger(OATrigger trigger,
                             boolean bSkipFirstNonManyProperty)
```
Not called directly, but used by OATriggerDelegate.createTrigger(..) to create, register and call a trigger.

Parameters:

trigger -

bSkipFirstNonManyProperty - if true then the first property of type prop/calc/one will not be listened to. This is used when a hubListener takes care of these changes.

removeTrigger

public void removeTrigger(OATrigger trigger)

_removeTrigger

protected void _removeTrigger(OATrigger trigger)

getHasTriggers
```
public boolean getHasTriggers()
```

getTriggers

public ArrayList<OATrigger> getTriggers(String propertyName)

onChange
```
public void onChange(OAObject fromObject,
                     String prop,
                     HubEvent hubEvent)
```
called by OAObject.propChange, Hub.add/remove/removeAll/insert, and OAObjectCacheDelegate when a change is made. This will then check to see if there is trigger method to send the change to.

setLookup
```
public void setLookup(boolean b)
```

getLookup
```
public boolean getLookup()
```

setPreSelect
```
public void setPreSelect(boolean b)
```

getPreSelect
```
public boolean getPreSelect()
```

setProcessed
```
public void setProcessed(boolean b)
```

getProcessed
```
public boolean getProcessed()
```

setViewDependentProperties

public void setViewDependentProperties(String[] ss)

getViewDependentProperties

public String[] getViewDependentProperties()

setContextDependentProperties

public void setContextDependentProperties(String[] ss)

getContextDependentProperties

public String[] getContextDependentProperties()

getEnabledProperty
```
public String getEnabledProperty()
```

setEnabledProperty

public void setEnabledProperty(String s)

getEnabledValue
```
public boolean getEnabledValue()
```

setEnabledValue

public void setEnabledValue(boolean b)

getVisibleProperty
```
public String getVisibleProperty()
```

setVisibleProperty

public void setVisibleProperty(String s)

getVisibleValue
```
public boolean getVisibleValue()
```

setVisibleValue

public void setVisibleValue(boolean b)

getContextEnabledProperty

public String getContextEnabledProperty()

setContextEnabledProperty

public void setContextEnabledProperty(String s)

getContextEnabledValue

public boolean getContextEnabledValue()

setContextEnabledValue

public void setContextEnabledValue(boolean b)

getContextVisibleProperty

public String getContextVisibleProperty()

setContextVisibleProperty

public void setContextVisibleProperty(String s)

getContextVisibleValue

public boolean getContextVisibleValue()

setContextVisibleValue

public void setContextVisibleValue(boolean b)

setEditQueryMethod

public void setEditQueryMethod(Method m)

getEditQueryMethod
```
public Method getEditQueryMethod()
```

getTimestampProperty

public OAPropertyInfo getTimestampProperty()

Class OAObjectInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

thisClass

alLinkInfo

alCalcInfo

hsHubCalcInfoName

idProperties

importMatchProperties

alPropertyInfo

alMethodInfo

bUseDataSource

bLocalOnly

bAddToCache

bInitializeNewObjects

displayName

rootTreePropertyPaths

primitiveProps

primitiveMask

hubProps

bSetRecursive

liRecursiveOne

liRecursiveMany

bSetLinkToOwner

liLinkToOwner

bProcessed

bLookup

hmTriggerInfo

bPreSelect

Constructor Detail

OAObjectInfo

OAObjectInfo

OAObjectInfo

Method Detail

getForClass

getIdProperties

isIdProperty

hasImportMatchProperties

getImportMatchProperties

getLinkInfos

addLink

addLinkInfo

getLinkInfo

getOwnedLinkInfos

isOwnedAndNoReverseMany

getOwnedByOne

getCalcInfos

getCalcInfo

addCalc

addCalcInfo

isHubCalcInfo

getPropertyInfos

addProperty

addPropertyInfo

getPropertyInfo

getMethodInfos

addMethod

addMethodInfo

getMethodInfo

getEditQueryMethod

addEditQueryMethod

getPrimitiveProperties

getHubProperties

setUseDataSource

getUseDataSource

setLocalOnly

getLocalOnly

setAddToCache

getAddToCache

setInitializeNewObjects

getInitializeNewObjects

getDisplayName

setDisplayName

getRootTreePropertyPaths

setRootTreePropertyPaths

addRequired