oracle.jbo.common

Class JboCompOper

java.lang.Object

oracle.jbo.common.JboCompOper

All Implemented Interfaces:

java.io.Serializable, DiffMergeable, DefPersistable, PersistentDefinition

public class JboCompOper
extends java.lang.Object
implements DefPersistable, java.io.Serializable, DiffMergeable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPER_AFTER This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_BEFORE This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_BETWEEN This is a framework defined system operator and not meant to be used by a custom operator.
static int	OPER_CARDINALITY_NO_MAX
static java.lang.String	OPER_CONTAINS This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_CONTAINS_ALL This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_CONTAINS_DELIMITED_ID This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_DOES_NOT_CONTAIN This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_ENDS_WITH This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_EQ This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_EXISTS This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_GE This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_GT This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_IN This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_IS_BLANK This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_IS_NOT_BLANK This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_LE This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_LIKE This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_LT This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_NE This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_NOT_BETWEEN This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_NOT_EXISTS This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_NOTIN This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_ON_OR_AFTER This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_ON_OR_BEFORE This is a framework defined system operator and not meant to be used by a custom operator.
static java.lang.String	OPER_STARTS_WITH This is a framework defined system operator and not meant to be used by a custom operator.
static int	OPER_TODO_ADD
static int	OPER_TODO_CLEAR
static int	OPER_TODO_KEEP
static int	OPER_TODO_REMOVE

Fields inherited from interface oracle.jbo.mom.xml.DefPersistable

FLAG_DIRTY, FLAG_EDITABLE, FLAG_FROM_TIP, FLAG_LOAD_BASE, FLAG_LOAD_HL_DEFS, FLAG_MAJOR_VERSION_CHANGED, FLAG_MINOR_VERSION_CHANGED, FLAG_NEW, FLAG_NEW_RECURSE, FLAG_SKIP_WRITE, XML_STATEMENT

Constructor Summary

Constructors

Constructor and Description
JboCompOper()
JboCompOper(int toDo, java.lang.Class msgBundleClass, java.lang.String strCode, java.lang.String oper) Creates an instance of a comparison operator used in view criteria
JboCompOper(int toDo, java.lang.Class msgBundleClass, java.lang.String strCode, java.lang.String oper, int minCardinality, int maxCardinality, java.lang.String expression) Creates an instance of a comparison operator used in view criteria
JboCompOper(int toDo, java.lang.String operDesc, java.lang.String oper, int minCardinality, int maxCardinality, java.lang.String expression) Creates an instance of a comparison operator used in view criteria
JboCompOper(int toDo, java.lang.String msgBundleClassName, java.lang.String strCode, java.lang.String oper, int minCardinality, int maxCardinality, java.lang.String expression) Creates an instance of a comparison operator used in view criteria
JboCompOper(java.lang.String id, int toDo, java.lang.Class msgBundleClass, java.lang.String strCode, java.lang.String oper, int minCardinality, int maxCardinality, java.lang.String expression) Creates an instance of a comparison operator used in view criteria.
JboCompOper(java.lang.String id, int toDo, java.lang.String operDesc, java.lang.String oper, int minCardinality, int maxCardinality, java.lang.String expression) Creates an instance of a comparison operator used in view criteria.
JboCompOper(java.lang.String id, int toDo, java.lang.String msgBundleClassName, java.lang.String strCode, java.lang.String oper, int minCardinality, int maxCardinality, java.lang.String expression) Creates an instance of a comparison operator used in view criteria.

Method Summary

Modifier and Type	Method and Description
static void	addCompOper(int typeGroup, java.lang.Class msgBundleClass, java.lang.String strCode, java.lang.String oper, int minCardinality, int maxCardinality) For internal use only to load framework operators for a particular type.
static void	addCompOper(int typeGroup, java.lang.String operDesc, java.lang.String oper, int minCardinality, int maxCardinality) For internal use only to load framework operators for a particular type.
static void	addCompOperEntry(int typeGroup, int toDo, java.lang.Class msgBundleClass, java.lang.String strCode, java.lang.String oper, int minCardinality, int maxCardinality) For internal use only to load framework operators for a particular type.
static void	addCompOperEntry(int typeGroup, int toDo, java.lang.String operDesc, java.lang.String oper, int minCardinality, int maxCardinality) For internal use only to load framework operators for a particular type.
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
void	applyDiffContents(DifferDetails dif, DiffResolver resolver) When diff/merge operation is requested, we have the following three def objects:
DifferDetails	beginDiffObjects(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) This method is the entry point call when the diffing process begins on the document-level def.
java.lang.Object	clone()
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
DifferDetails	diffObjects(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) The work-horse method performing diff between two defs of this def type.
DifferDetails	ensureDifferDetails(DifferDetails difDetails) Ensures that we have a valid DifferDetails.
boolean	equals(java.lang.Object other)
static java.util.HashMap	getAllBaseCompOpers(LocaleContext locale) For internal use only.
static java.lang.String[][]	getBaseCompOpers(LocaleContext locale) For internal use only.
static void	getCompOperList(int typeGroup, java.util.ArrayList list) The list of operators for a specific type.
java.lang.String	getDefTypeName() Returns the XML def type name of this defintion object, e.g., "PDefEntityObject".
java.lang.String	getDefXMLElementTag() For internal use only
java.lang.String	getDefXMLNameSpace() For internal use only
java.lang.String	getExpression()
ExpressionDef	getExpressionDef()
java.lang.String	getFullName() This method returns the Persistence reference of the object.
java.lang.String	getId()
java.lang.String	getIdentificationAttributeName() return the attribute name for identification on an xml element.
int	getMaxCardinality()
java.lang.String	getMergeableFullName() Returns the fully qualified name of the diff-mergeable definition object.
java.lang.String	getMergeableName() Returns the diff-mergeable definition's name (short form).
java.lang.Class	getMessageBundleClass()
int	getMinCardinality()
java.lang.String	getName()
java.lang.String	getOper()
java.lang.String	getOperDesc()
java.lang.String	getOperDescStr(LocaleContext locale)
java.lang.String	getOperDescStrCode()
DefPersistable	getOrigObject()
int	getToDo()
java.lang.String	getXMLElementTag() For internal use only
void	init(java.lang.String id, int toDo, java.lang.String strCode, java.lang.String oper, int minCardinality, int maxCardinality, java.lang.String expression)
static void	internalSealStaticOpers() Deprecated. since 11.1.1.5.1 For internal framework use only. Implementation and signature may change without notice.
boolean	isDirty() This method returns if an Object is modified from last save/load
boolean	isNew() This method returns if this object is previously persisted.
boolean	isNewRecurse()
boolean	isRelationalOperator() If a view criteria item has a value set, temporary bind variables are generated for the values to use statement caching efficiently.
boolean	isSkipWrite()
boolean	isWriteObject(DefPersistable parentObj, DefWriter defWriter)
void	loadXMLContent(DefElement xmlElement)
static void	mergeEntries(java.util.ArrayList opers, java.util.ArrayList list) For internal use only.
static void	mergeEntry(java.util.ArrayList list, int toDo, java.lang.Object ent) For internal use only.
static void	populateCompOpers()
static java.lang.String[][]	processCompOpers(LocaleContext locale, java.util.ArrayList list)
void	setDirty(boolean b) This method marks the Object dirty
void	setExpressionDef(ExpressionDef exprDef)
void	setMessageBundleClass(java.lang.Class cls)
void	setMessageBundleClassName(java.lang.String msgBundleClassName)
void	setNew(boolean b) This method marks the as previously persisted.
void	setNewRecurse(boolean b)
void	setOperDesc(java.lang.String operDesc) sets the non-translatable operator description.
void	setOrigObject(DefPersistable oldObj)
void	setResourceBundleDef(ResourceBundleDef def)
void	setSkipWrite(boolean b)
void	writeChildren(DefWriter jos) Writes the Object's children to the Persistent storage
void	writeContents(DefWriter jos) Objects should write their persistence output in this method
void	writeContents(DefWriter jos, boolean bWriteId)
void	writeObject(DefWriter jos) Objects should write their persistence output in this method

Methods inherited from class java.lang.Object

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

Field Detail

OPER_EQ

public static final java.lang.String OPER_EQ

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_GT

public static final java.lang.String OPER_GT

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_GE

public static final java.lang.String OPER_GE

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_LT

public static final java.lang.String OPER_LT

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_LE

public static final java.lang.String OPER_LE

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_NE

public static final java.lang.String OPER_NE

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_LIKE

public static final java.lang.String OPER_LIKE

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_CONTAINS

public static final java.lang.String OPER_CONTAINS

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_DOES_NOT_CONTAIN

public static final java.lang.String OPER_DOES_NOT_CONTAIN

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_CONTAINS_DELIMITED_ID

public static final java.lang.String OPER_CONTAINS_DELIMITED_ID

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_STARTS_WITH

public static final java.lang.String OPER_STARTS_WITH

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_ENDS_WITH

public static final java.lang.String OPER_ENDS_WITH

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_IS_BLANK

public static final java.lang.String OPER_IS_BLANK

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_IS_NOT_BLANK

public static final java.lang.String OPER_IS_NOT_BLANK

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_BETWEEN

public static final java.lang.String OPER_BETWEEN

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_NOT_BETWEEN

public static final java.lang.String OPER_NOT_BETWEEN

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_BEFORE

public static final java.lang.String OPER_BEFORE

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_AFTER

public static final java.lang.String OPER_AFTER

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_ON_OR_BEFORE

public static final java.lang.String OPER_ON_OR_BEFORE

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_ON_OR_AFTER

public static final java.lang.String OPER_ON_OR_AFTER

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_EXISTS

public static final java.lang.String OPER_EXISTS

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_NOT_EXISTS

public static final java.lang.String OPER_NOT_EXISTS

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_IN

public static final java.lang.String OPER_IN

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_NOTIN

public static final java.lang.String OPER_NOTIN

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_CONTAINS_ALL

public static final java.lang.String OPER_CONTAINS_ALL

This is a framework defined system operator and not meant to be used by a custom operator.

See Also:

Constant Field Values

OPER_TODO_KEEP

public static final int OPER_TODO_KEEP

See Also:

Constant Field Values

OPER_TODO_ADD

public static final int OPER_TODO_ADD

See Also:

Constant Field Values

OPER_TODO_REMOVE

public static final int OPER_TODO_REMOVE

See Also:

Constant Field Values

OPER_TODO_CLEAR

public static final int OPER_TODO_CLEAR

See Also:

Constant Field Values

OPER_CARDINALITY_NO_MAX

public static final int OPER_CARDINALITY_NO_MAX

See Also:

Constant Field Values

Constructor Detail

JboCompOper

public JboCompOper()

JboCompOper

public JboCompOper(int toDo,
                   java.lang.Class msgBundleClass,
                   java.lang.String strCode,
                   java.lang.String oper)

Creates an instance of a comparison operator used in view criteria

Parameters:

toDo - use OPER_TODO_ADD, OPER_TODO_REMOVE and OPER_TODO_CLEAR to add, remove or remove all operators defined on the owner.

msgBundleClass - the message bundle that holds the description of the operator displayed in the search form

strCode - the key used to lookup the message bundle

oper - the operator string saved in the view criteria item xml. For example oper could be ">" msgbundleClass could be "OperatorsBundle" and strCode could be "GREATER_THAN". The bundle may contain the value "Greater than" for key "GREATER_THAN".

JboCompOper

public JboCompOper(int toDo,
                   java.lang.Class msgBundleClass,
                   java.lang.String strCode,
                   java.lang.String oper,
                   int minCardinality,
                   int maxCardinality,
                   java.lang.String expression)

Creates an instance of a comparison operator used in view criteria

Parameters:

toDo - use OPER_TODO_ADD, OPER_TODO_REMOVE and OPER_TODO_CLEAR to add, remove or remove all operators defined on the owner

msgBundleClass - the message bundle that holds the description of the operator displayed in the search form

strCode - the key used to lookup the message bundle

oper - the operator string saved in the view criteria item xml. For example oper could be ">" msgbundleClass could be "OperatorsBundle" and strCode could be "GREATER_THAN". The bundle may contain the value "Greater than" for key "GREATER_THAN".

minCardinality - the minimum cardinality of the operator. for example "greater than" has a minimum cardinality of 1 and "is not null" operator has a minimum cardinality of 0.

maxCardinality - the maximum cardinality of the operator. for example "greater than" has a maximum cardinality of 1 and "between" has a maximum cardinality of 2.

expression - a groovy expression that returns a where clause fragment. The expression is passed a reference to a ViewCriteriaItem and can introspect into the values of the item by calling public methods on it.

JboCompOper

public JboCompOper(java.lang.String id,
                   int toDo,
                   java.lang.Class msgBundleClass,
                   java.lang.String strCode,
                   java.lang.String oper,
                   int minCardinality,
                   int maxCardinality,
                   java.lang.String expression)

Creates an instance of a comparison operator used in view criteria. Use this constructor if this operator will be written out to xml for DT@RT usages.

Parameters:

id - The string used to identify a comp operator occurence uniquely under an owner. Theoretically a user can remove a system provided operator and implement an overridden version. For example TODO_REMOVE, > and TODO_ADD, > custom expression. The same operator is repeated twice and hence the need to introduce a unique attribute to identify an element.

toDo - use OPER_TODO_ADD, OPER_TODO_REMOVE and OPER_TODO_CLEAR to add, remove or remove all operators defined on the owner

msgBundleClass - the message bundle that holds the description of the operator displayed in the search form

strCode - the key used to lookup the message bundle

oper - the operator string saved in the view criteria item xml. For example oper could be ">" msgbundleClass could be "OperatorsBundle" and strCode could be "GREATER_THAN". The bundle may contain the value "Greater than" for key "GREATER_THAN".

minCardinality - the minimum cardinality of the operator. for example "greater than" has a minimum cardinality of 1 and "is not null" operator has a minimum cardinality of 0.

maxCardinality - the maximum cardinality of the operator. for example "greater than" has a maximum cardinality of 1 and "between" has a maximum cardinality of 2.

expression - a groovy expression that returns a where clause fragment. The expression is passed a reference to a ViewCriteriaItem and can introspect into the values of the item by calling public methods on it.

JboCompOper

public JboCompOper(int toDo,
                   java.lang.String msgBundleClassName,
                   java.lang.String strCode,
                   java.lang.String oper,
                   int minCardinality,
                   int maxCardinality,
                   java.lang.String expression)

Creates an instance of a comparison operator used in view criteria

Parameters:

toDo - use OPER_TODO_ADD, OPER_TODO_REMOVE and OPER_TODO_CLEAR to add, remove or remove all operators defined on the owner

msgBundleClassName - the message bundle name that holds the description of the operator displayed in the search form

strCode - the key used to lookup the message bundle

oper - the operator string saved in the view criteria item xml. For example oper could be ">" msgbundleClass could be "OperatorsBundle" and strCode could be "GREATER_THAN". The bundle may contain the value "Greater than" for key "GREATER_THAN".

minCardinality - the minimum cardinality of the operator. for example "greater than" has a minimum cardinality of 1 and "is not null" operator has a minimum cardinality of 0.

maxCardinality - the maximum cardinality of the operator. for example "greater than" has a maximum cardinality of 1 and "between" has a maximum cardinality of 2.

expression - a groovy expression that returns a where clause fragment. The expression is passed a reference to a ViewCriteriaItem and can introspect into the values of the item by calling public methods on it.

JboCompOper

public JboCompOper(java.lang.String id,
                   int toDo,
                   java.lang.String msgBundleClassName,
                   java.lang.String strCode,
                   java.lang.String oper,
                   int minCardinality,
                   int maxCardinality,
                   java.lang.String expression)

Creates an instance of a comparison operator used in view criteria. Use this constructor if this operator will be written out to xml for DT@RT usages.

Parameters:

id - The string used to identify a comp operator occurence uniquely under an owner. Theoretically a user can remove a system provided operator and implement an overridden version. For example TODO_REMOVE, > and TODO_ADD, > custom expression. The same operator is repeated twice and hence the need to introduce a unique attribute to identify an element.

toDo - use OPER_TODO_ADD, OPER_TODO_REMOVE and OPER_TODO_CLEAR to add, remove or remove all operators defined on the owner

msgBundleClassName - the message bundle name that holds the description of the operator displayed in the search form

strCode - the key used to lookup the message bundle

oper - the operator string saved in the view criteria item xml. For example oper could be ">" msgbundleClass could be "OperatorsBundle" and strCode could be "GREATER_THAN". The bundle may contain the value "Greater than" for key "GREATER_THAN".

minCardinality - the minimum cardinality of the operator. for example "greater than" has a minimum cardinality of 1 and "is not null" operator has a minimum cardinality of 0.

maxCardinality - the maximum cardinality of the operator. for example "greater than" has a maximum cardinality of 1 and "between" has a maximum cardinality of 2.

expression - a groovy expression that returns a where clause fragment. The expression is passed a reference to a ViewCriteriaItem and can introspect into the values of the item by calling public methods on it.

JboCompOper

public JboCompOper(int toDo,
                   java.lang.String operDesc,
                   java.lang.String oper,
                   int minCardinality,
                   int maxCardinality,
                   java.lang.String expression)

Creates an instance of a comparison operator used in view criteria

Parameters:

toDo - use OPER_TODO_ADD, OPER_TODO_REMOVE and OPER_TODO_CLEAR to add, remove or remove all operators defined on the owner.

operDesc - a non-translatable description for the operator.

oper - the operator string saved in the view criteria item xml. For example oper could be ">" operDesc could be passed in as "Greater than".

minCardinality - the minimum cardinality of the operator. for example "greater than" has a minimum cardinality of 1 and "is not null" operator has a minimum cardinality of 0.

maxCardinality - the maximum cardinality of the operator. for example "greater than" has a maximum cardinality of 1 and "between" has a maximum cardinality of 2.

expression - a groovy expression that returns a where clause fragment. The expression is passed a reference to a ViewCriteriaItem and can introspect into the values of the item by calling public methods on it.

JboCompOper

public JboCompOper(java.lang.String id,
                   int toDo,
                   java.lang.String operDesc,
                   java.lang.String oper,
                   int minCardinality,
                   int maxCardinality,
                   java.lang.String expression)

Creates an instance of a comparison operator used in view criteria. Use this constructor if this operator will be written out to xml for DT@RT usages.

Parameters:

id - The string used to identify a comp operator occurence uniquely under an owner. Theoretically a user can remove a system provided operator and implement an overridden version. For example TODO_REMOVE, > and TODO_ADD, > custom expression. The same operator is repeated twice and hence the need to introduce a unique attribute to identify an element.

toDo - use OPER_TODO_ADD, OPER_TODO_REMOVE and OPER_TODO_CLEAR to add, remove or remove all operators defined on the owner.

operDesc - a non-translatable description for the operator.

oper - the operator string saved in the view criteria item xml. For example oper could be ">" operDesc could be passed in as "Greater than".

minCardinality - the minimum cardinality of the operator. for example "greater than" has a minimum cardinality of 1 and "is not null" operator has a minimum cardinality of 0.

maxCardinality - the maximum cardinality of the operator. for example "greater than" has a maximum cardinality of 1 and "between" has a maximum cardinality of 2.

expression - a groovy expression that returns a where clause fragment. The expression is passed a reference to a ViewCriteriaItem and can introspect into the values of the item by calling public methods on it.

Method Detail

init

@Concealed
public void init(java.lang.String id,
                            int toDo,
                            java.lang.String strCode,
                            java.lang.String oper,
                            int minCardinality,
                            int maxCardinality,
                            java.lang.String expression)

For internal use only. Application developers should not use this

*** For internal framework use only ***

internalSealStaticOpers

@Concealed
public static void internalSealStaticOpers()

Deprecated. since 11.1.1.5.1 For internal framework use only. Implementation and signature may change without notice.

For internal use only. Application developers should not use this

populateCompOpers

public static void populateCompOpers()

addCompOper

public static void addCompOper(int typeGroup,
                               java.lang.Class msgBundleClass,
                               java.lang.String strCode,
                               java.lang.String oper,
                               int minCardinality,
                               int maxCardinality)

For internal use only to load framework operators for a particular type.

addCompOper

public static void addCompOper(int typeGroup,
                               java.lang.String operDesc,
                               java.lang.String oper,
                               int minCardinality,
                               int maxCardinality)

For internal use only to load framework operators for a particular type.

addCompOperEntry

public static void addCompOperEntry(int typeGroup,
                                    int toDo,
                                    java.lang.Class msgBundleClass,
                                    java.lang.String strCode,
                                    java.lang.String oper,
                                    int minCardinality,
                                    int maxCardinality)

For internal use only to load framework operators for a particular type.

addCompOperEntry

public static void addCompOperEntry(int typeGroup,
                                    int toDo,
                                    java.lang.String operDesc,
                                    java.lang.String oper,
                                    int minCardinality,
                                    int maxCardinality)

For internal use only to load framework operators for a particular type.

mergeEntry

public static void mergeEntry(java.util.ArrayList list,
                              int toDo,
                              java.lang.Object ent)

For internal use only. Manges a operator list for an owner by adding or removing entries.

Parameters:

list - the collected list of operators.

toDo - OPER_TODO_ADD, OPER_TODO_REMOVE and OPER_TODO_CLEAR to add, remove or remove all operators defined on the owner.

ent - the operator entry that is applying the change.

mergeEntries

public static void mergeEntries(java.util.ArrayList opers,
                                java.util.ArrayList list)

For internal use only. Manges a operator list for an owner by adding or removing entries.

Parameters:

opers - the collected list of operators.

list - the list of changes to be applied on opers.

getCompOperList

public static void getCompOperList(int typeGroup,
                                   java.util.ArrayList list)

The list of operators for a specific type. Used in View Criteria design time to default the correct operators for a data type.

Parameters:

typeGroup - the type for which the operators need to be returned.

list - the list of operators.

getAllBaseCompOpers

public static java.util.HashMap getAllBaseCompOpers(LocaleContext locale)

For internal use only.

Returns:

a deep copy of the system level operators.

getBaseCompOpers

public static java.lang.String[][] getBaseCompOpers(LocaleContext locale)

For internal use only.

Returns:

a deep copy of system level operators for the default type.

processCompOpers

public static java.lang.String[][] processCompOpers(LocaleContext locale,
                                                    java.util.ArrayList list)

Parameters:

locale - the locale to fetch the operator descriptions

list - the list of operators

Returns:

an n x 2 array where n is the size of list and each element containing the operator name and description

getToDo

public int getToDo()

Returns:

OPER_TODO_ADD, OPER_TODO_REMOVE and OPER_TODO_CLEAR to add, remove or remove all operators defined on the owner.

getId

public java.lang.String getId()

getMessageBundleClass

public java.lang.Class getMessageBundleClass()

Returns:

The message bundle class that holds the description of the operator.

setMessageBundleClass

public void setMessageBundleClass(java.lang.Class cls)

Parameters:

cls - The message bundle class that holds the description of the operator.

setMessageBundleClassName

public void setMessageBundleClassName(java.lang.String msgBundleClassName)

Parameters:

cls - The message bundle class name that holds the description of the operator.

setResourceBundleDef

public void setResourceBundleDef(ResourceBundleDef def)

Parameters:

def - ResourceBundleDef is an abstraction around alternate message bundle types supported by the framework like xlf, properties bundle.

getOperDescStrCode

public java.lang.String getOperDescStrCode()

Returns:

The message bundle or resource bundle key to look up the operator description.

getOperDesc

public java.lang.String getOperDesc()

Returns:

If supplied during creation, the non-translatable operator description.

getOperDescStr

public java.lang.String getOperDescStr(LocaleContext locale)

Parameters:

locale - the locale used to fetch the operator description

Returns:

the description of the operator for a specific locale.

setOperDesc

public void setOperDesc(java.lang.String operDesc)

sets the non-translatable operator description.

getMinCardinality

public int getMinCardinality()

getMaxCardinality

public int getMaxCardinality()

getOper

public java.lang.String getOper()

getExpression

public java.lang.String getExpression()

getExpressionDef

public ExpressionDef getExpressionDef()

setExpressionDef

public void setExpressionDef(ExpressionDef exprDef)

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

isDirty

public boolean isDirty()

Description copied from interface: DefPersistable

This method returns if an Object is modified from last save/load

Specified by:

isDirty in interface DefPersistable

Returns:

Returns true if the Object is dirty. Returns false otherwise.

setDirty

public void setDirty(boolean b)

Description copied from interface: DefPersistable

This method marks the Object dirty

Specified by:

setDirty in interface DefPersistable

Parameters:

b - If true the Object is marked Dirty.

isNew

public boolean isNew()

Description copied from interface: DefPersistable

This method returns if this object is previously persisted.

Specified by:

isNew in interface DefPersistable

Returns:

true if the Object is previously persisted. Returns false otherwise.

setNew

public void setNew(boolean b)

Description copied from interface: DefPersistable

This method marks the as previously persisted. By default all objects are new objects. When the object is persisted first time, that object is marked as 'not new' object

Specified by:

setNew in interface DefPersistable

Parameters:

b - If true the Object is marked as new object.

isNewRecurse

public boolean isNewRecurse()

Specified by:

isNewRecurse in interface DefPersistable

setNewRecurse

public void setNewRecurse(boolean b)

Specified by:

setNewRecurse in interface DefPersistable

isSkipWrite

public boolean isSkipWrite()

Specified by:

isSkipWrite in interface DefPersistable

setSkipWrite

public void setSkipWrite(boolean b)

Specified by:

setSkipWrite in interface DefPersistable

isWriteObject

public boolean isWriteObject(DefPersistable parentObj,
                             DefWriter defWriter)

Specified by:

isWriteObject in interface DefPersistable

getName

public java.lang.String getName()

getFullName

public java.lang.String getFullName()

Description copied from interface: DefPersistable

This method returns the Persistence reference of the object. The Persistence Reference is uniquely identifiable fully qualified name of the object.

Specified by:

getFullName in interface DefPersistable

Returns:

the Persistence Reference of the object

getMergeableName

public java.lang.String getMergeableName()

Description copied from interface: DiffMergeable

Returns the diff-mergeable definition's name (short form).

Specified by:

getMergeableName in interface DiffMergeable

Returns:

name of the def object

getMergeableFullName

public java.lang.String getMergeableFullName()

Description copied from interface: DiffMergeable

Returns the fully qualified name of the diff-mergeable definition object. It must uniquely identify the def object.

Specified by:

getMergeableFullName in interface DiffMergeable

Returns:

full name of the def object

getOrigObject

public DefPersistable getOrigObject()

Specified by:

getOrigObject in interface DefPersistable

setOrigObject

public void setOrigObject(DefPersistable oldObj)

Specified by:

setOrigObject in interface DefPersistable

writeObject

public void writeObject(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeObject in interface PersistentDefinition

Parameters:

jos - the Output storage for persistence

writeContents

public void writeContents(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeContents in interface PersistentDefinition

Parameters:

jos - the Output storage for persistence

writeContents

public void writeContents(DefWriter jos,
                          boolean bWriteId)

writeChildren

public void writeChildren(DefWriter jos)

Description copied from interface: PersistentDefinition

Writes the Object's children to the Persistent storage

Specified by:

writeChildren in interface PersistentDefinition

Parameters:

jos - the Output storage for persistence

loadXMLContent

public void loadXMLContent(DefElement xmlElement)

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

For internal use only

Specified by:

getDefXMLElementTag in interface PersistentDefinition

getDefTypeName

public java.lang.String getDefTypeName()

Description copied from interface: DiffMergeable

Returns the XML def type name of this defintion object, e.g., "PDefEntityObject".

Specified by:

getDefTypeName in interface DiffMergeable

Returns:

XML def type name

getXMLElementTag

public java.lang.String getXMLElementTag()

For internal use only

Specified by:

getXMLElementTag in interface PersistentDefinition

Returns:

returns the Statement required to store in Persitent Storage. Incase of XML, it just returns the String. In the case of SQL a JDBC PreparedStatement is returned.

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

For internal use only

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

getIdentificationAttributeName

public java.lang.String getIdentificationAttributeName()

Description copied from interface: PersistentDefinition

return the attribute name for identification on an xml element. Note, for most def objects, the string "Name" should be returned; for someone that has no "Name" attribute, you need to designate one. e.g. For adfmcatalog.xml, "fullName" is returned For most other metadatas, "Name" is returned

Specified by:

getIdentificationAttributeName in interface PersistentDefinition

isRelationalOperator

public boolean isRelationalOperator()

If a view criteria item has a value set, temporary bind variables are generated for the values to use statement caching efficiently. If the operator is a relational operator then the temporary bind var type is set to the same type we compare against.

Returns:

true if the operator is relational.

ensureDifferDetails

public DifferDetails ensureDifferDetails(DifferDetails difDetails)

Description copied from interface: DiffMergeable

Ensures that we have a valid DifferDetails.

This method is to create a DifferDetails object to be used for diffing if necessary. The difDetails may come in as null. By calling this method, we can ensure that a non-null difDetails is there. So, instead of writing:

    if (difDetails == null)
    {
       difDetails = new DifferDetails(..);
    }
    difDetails.addDiffDetail(..);
 

we can write

    (difDetails = diffMergeable.ensureDifferDetails(difDetails)).addDiffDetail(..);
 

Specified by:

ensureDifferDetails in interface DiffMergeable

Parameters:

difDetails - the incoming DifferDetails. It may be null.

Returns:

the same difDetails if it wasn't null coming in, or a new DifferDetails if the incoming difDetails was null

diffContents

public DifferDetails diffContents(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)

Description copied from interface: DiffMergeable

Performs diff of scalar values. Typically, scalar attr values are grouped into String, int, and boolean arrays -- one set coming from 'this' definition and the other set coming from orgDef. Then, help methods on DifferBase can be used to diff the attr values and accumulate the details of diff in difDetails.

Here is example code snippet:

    private static final String DIFF_STRING_ELEMS[] =
    {
       "MyStringVal1",
       "MyStringVal2"
    };

    private static final String DIFF_INT_ELEMS[] =
    {
       "MyIntVal",
    }

    public DifferDetails diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
       <Your-def-class> orgDefImpl = (<Your-def-class>) orgDef;

       final String editStringValues[] =
       {
          this.getMyStringVal1(),
          this.getMyStringVal2()
       };

       String orgStringValues[] = null;

       if (orgDef != null)
       {
          String orgV[] =
          {
             orgDefImpl.getMyStringVal1(),
             orgDefImpl.getMyStringVal2()
          };

          orgStringValues = orgV;
       }

       final int editIntValues[] =
       {
          this.getMyIntVal(),
       };

       int orgIntValues[] = null;

       if (orgDef != null)
       {
          int orgV[] =
          {
             orgDefImpl.getMyIntVal()
          };

          orgIntValues = orgV;
       }

       difDetails = DifferBase.diffStringArray(this, DIFF_STRING_ELEMS, editStringValues, orgStringValues, difDetails);
       difDetails = DifferBase.diffIntArray(this, DIFF_INT_ELEMS, editIntValues, orgIntValues, difDetails);

       return difDetails;
   }
 

Specified by:

diffContents in interface DiffMergeable

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

diffChildren

public DifferDetails diffChildren(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)

Description copied from interface: DiffMergeable

Performs diff of children defs. This def should enumerate through all its children and diff them and accumulate details of diff into difDetails and return it at the end.

For example, if this def has Child1 and Child2, its implementation should look something like:

    public DifferDetails diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);

       return difDetails;
    }
 

where diffChildrenChild1() uses DifferChildren's helper method diffChildrenList to diff the child defs.

Specified by:

diffChildren in interface DiffMergeable

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

beginDiffObjects

public DifferDetails beginDiffObjects(DiffMergeable docDef,
                                      DiffMergeable orgDef,
                                      DifferDetails difDetails)

Description copied from interface: DiffMergeable

This method is the entry point call when the diffing process begins on the document-level def. This document-level def may perform its setup or preparation operations and then traverse into nested (children) DiffMergeable's. 'this' object is the changed definition.

Specified by:

beginDiffObjects in interface DiffMergeable

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

diffObjects

public DifferDetails diffObjects(DiffMergeable docDef,
                                 DiffMergeable orgDef,
                                 DifferDetails difDetails)

Description copied from interface: DiffMergeable

The work-horse method performing diff between two defs of this def type. Most typically, it will call diffContents to diff scalar values and diffChildren to diff children objects. The children objects themselves are expected to be DiffMergeable. 'this' object is the changed definition.

Specified by:

diffObjects in interface DiffMergeable

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

applyDiffChildren

public void applyDiffChildren(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

Applies changes to children defs. dif contains the changes to be applied to the children. For each child def, this method should first retrieve the diff details for the child, which is of type DifferChildren. Then, it should call DifferChildren.applyDiffChanges(oracle.jbo.mom.DiffChildrenMerge, oracle.jbo.mom.DiffResolver) to perform the change operation.

applyChanges() requires a DiffChildrenMerge object, which has the insert, update, and remove methods. 'this' def object must provide implmementation of these operations.

Here is a sample:

    public void applyDiffChildren(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();

       if (detailMap != null)
       {
          DifferChildren difChild1 = (DifferChildren) detailMap.getValue(<XML-tag-for-Child1>);

          if (difVCs != null)
          {
             DiffChildrenMerge dm = new DiffChildrenMerge()
             {
                public void insertChild(Object id, Object value)
                {
                   .. perform insert op for Child1 ..
                }

                public void updateChild(Object id, Object value, Object oldValue)
                {
                   .. perform update op for Child1 ..
                }

                public void removeChild(Object id)
                {
                   .. perform remove op for Child1 ..
                }
             };

             difChild1.applyDiffChanges(dm, resolver);
          }

          // Similarly for Child2
       }
    }
 

Specified by:

applyDiffChildren in interface DiffMergeable

applyDiffContents

public void applyDiffContents(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

When diff/merge operation is requested, we have the following three def objects:

orgDef - original def object (from the branch point) editDef - def object into which changes are to be merge toMergeDef - def object to be merged (source of changes) For sandbox refresh operation, orgDef comes from the branch point, editDef from the sandbox, toMergeDef from the mainline of the repos. With these three defs, we first diff editDef against orgDef, producing editDifDetails.

Similarly, toMergeDef is diffed against orgDef, producing toMergeDifDetails. The diff engine then walks through these two sets of diffs and identifies conflicts. After the conflicts are all resolved, we apply appropriate changes to editDef.

applyDiffContents is called to apply changes to scalar values. dif contains the changed values to be applied to 'this' object. Use sample code like the following:

    public void applyDiffContents(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();
       Object[] updValues;

       // DIFF_STRING_ELEMS from the above example code
       for (int j = 0; j < DIFF_STRING_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_STRING_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyStringVal1((String) updValues[0]);
                break;
             case 1:
                 setMyStringVal2((String) updValues[0]);
                break;
             }
          }
       }

       for (int j = 0; j < DIFF_INT_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_INT_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyIntVal((Integer) updValues[0]);
                break;
             }
          }
       }
    }
 

Notice that the index specified in the case statement is the array index of the attr in the String, int, or boolean array.

Specified by:

applyDiffContents in interface DiffMergeable

Parameters:

dif - changes to be applied to 'this' def

resolver - the diff resolver used in diff/merge operation