com.businessobjects.sdk.lcm

Class ObjectMatcher

java.lang.Object

com.businessobjects.sdk.lcm.ObjectMatcher

public class ObjectMatcher
extends Object

Builder for object selection offering symbolic querying

See Also:

package description

Method Summary

Modifier and Type	Method and Description
static ObjectMatcher	and(ObjectMatcher m1, ObjectMatcher m2) Creates a matcher that matches all of the given ones.
static ObjectMatcher	cuidIs(String... cuids) Creates a matcher that matches object(s) of any given cuid.
static ObjectMatcher	idIs(Integer... ids) Creates a matcher that matches object(s) of any given id.
static ObjectMatcher	isInstance(boolean state) Creates a matcher that matches or rejects instance (s).
static ObjectMatcher	isInstanceObject(boolean state) Creates a matcher that matches or rejects instance object(s).
static ObjectMatcher	kindIs(String... kinds) Creates a matcher that matches object(s) of any given kind.
static ObjectMatcher	nameIs(String... names) Creates a matcher that matches object(s) of any given name.
static ObjectMatcher	not(ObjectMatcher m) Creates a matcher that negates given one.
static ObjectMatcher	or(ObjectMatcher m1, ObjectMatcher m2) Creates a matcher that matches any of the given ones.
static ObjectMatcher	parentCuidIs(String... cuids) Creates a matcher that matches object(s) whose parent is of any given cuid.
static ObjectMatcher	parentIdIs(Integer... ids) Creates a matcher that matches object(s) whose parent is of any given id.

Methods inherited from class java.lang.Object

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

Method Detail

not

public static ObjectMatcher not(ObjectMatcher m)

Creates a matcher that negates given one.

Parameters:

m - matcher to be negated

Returns:

a new matcher instance

or

public static ObjectMatcher or(ObjectMatcher m1,
                               ObjectMatcher m2)

Creates a matcher that matches any of the given ones.

Parameters:

m1 - first matcher

m2 - second matcher

Returns:

a new matcher instance

and

public static ObjectMatcher and(ObjectMatcher m1,
                                ObjectMatcher m2)

Creates a matcher that matches all of the given ones.

Parameters:

m1 - first matcher

m2 - second matcher

Returns:

a new matcher instance

nameIs

public static ObjectMatcher nameIs(String... names)
                            throws com.businessobjects.lcm.utilities.LCMException

Creates a matcher that matches object(s) of any given name.

Parameters:

names - name candidate list

Returns:

a new matcher instance

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

kindIs

public static ObjectMatcher kindIs(String... kinds)
                            throws com.businessobjects.lcm.utilities.LCMException

Creates a matcher that matches object(s) of any given kind.

Parameters:

kinds - kind candidate list

Returns:

a new matcher instance

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

cuidIs

public static ObjectMatcher cuidIs(String... cuids)
                            throws com.businessobjects.lcm.utilities.LCMException

Creates a matcher that matches object(s) of any given cuid.

Parameters:

cuids - cuid candidate list

Returns:

a new matcher instance

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

idIs

public static ObjectMatcher idIs(Integer... ids)
                          throws com.businessobjects.lcm.utilities.LCMException

Creates a matcher that matches object(s) of any given id.

Parameters:

ids - id candidate list

Returns:

a new matcher instance

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

isInstance

public static ObjectMatcher isInstance(boolean state)
                                throws com.businessobjects.lcm.utilities.LCMException

Creates a matcher that matches or rejects instance (s).

Parameters:

state - desired instance state

Returns:

a new matcher instance

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

isInstanceObject

public static ObjectMatcher isInstanceObject(boolean state)
                                      throws com.businessobjects.lcm.utilities.LCMException

Creates a matcher that matches or rejects instance object(s).

Parameters:

state - desired instance object state

Returns:

a new matcher instance

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

parentCuidIs

public static ObjectMatcher parentCuidIs(String... cuids)
                                  throws com.businessobjects.lcm.utilities.LCMException

Creates a matcher that matches object(s) whose parent is of any given cuid.

Parameters:

cuids - parent cuid candidate list

Returns:

a new matcher instance

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

parentIdIs

public static ObjectMatcher parentIdIs(Integer... ids)
                                throws com.businessobjects.lcm.utilities.LCMException

Creates a matcher that matches object(s) whose parent is of any given id.

Parameters:

ids - parent id candidate list

Returns:

a new matcher instance

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error