wt.index
Class IndexPolicyRule

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.index.IndexPolicyRule

All Implemented Interfaces:

AccessControlled, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class IndexPolicyRule

extends Item

implements Externalizable

IndexPolicyRule objects indicate what indexers are applicable when an event happens to an object. Other characteristics of the object that influence which indexers are applicable are the domain of the object, the type and the state of the object in addition to the event itself.

Each IndexPolicyRule object contains a Selector object (which stands for the antecedent of the rule) and an IndexerSet object (which is the consequent of the rule). Rules are stored persistently but are not directly subject to access control.

Use the newIndexPolicyRule static factory method(s), not the IndexPolicyRule constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private IndexerSet	indexers
static String	INDEXERS Label for the attribute; Set of indexers that constitute the rule's consequent.
private static int	INDEXERS_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private Selector	selector
static String	SELECTOR Label for the attribute.
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.Item

VERSION_40_UID, VERSION_51_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

IndexPolicyRule()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
IndexerSet	getIndexers() Gets the value of the attribute: INDEXERS.
Selector	getSelector() Gets the object for the association that plays role: SELECTOR.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(Selector sel) Supports initialization, following construction of an instance.
protected static IndexPolicyRule	newIndexPolicyRule(Selector sel) Construct an index policy rule for the given selector.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(IndexPolicyRule thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	selectorValidate(Selector a_Selector)
void	setIndexers(IndexerSet a_Indexers) Sets the value of the attribute: INDEXERS.
protected void	setSelector(Selector a_Selector) Sets the object for the association that plays role: SELECTOR.
String	toString() Returns a string representation of the rule.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.fc.Item

getDomainRef, initialize, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

INDEXERS

public static final String INDEXERS

Label for the attribute; Set of indexers that constitute the rule's consequent.

Supported API: false

See Also:

Constant Field Values

INDEXERS_UPPER_LIMIT

private static int INDEXERS_UPPER_LIMIT

indexers

private IndexerSet indexers

SELECTOR

public static final String SELECTOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

selector

private Selector selector

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

IndexPolicyRule

public IndexPolicyRule()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Item

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(IndexPolicyRule thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class Item

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getIndexers

public IndexerSet getIndexers()

Gets the value of the attribute: INDEXERS. Set of indexers that constitute the rule's consequent.

Supported API: false

Returns:

IndexerSet

setIndexers

public void setIndexers(IndexerSet a_Indexers)

Sets the value of the attribute: INDEXERS. Set of indexers that constitute the rule's consequent.

Supported API: false

Parameters:

a_Indexers -

getSelector

public Selector getSelector()

Gets the object for the association that plays role: SELECTOR.

Supported API: false

Returns:

Selector

setSelector

protected void setSelector(Selector a_Selector)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: SELECTOR.

Supported API: false

Parameters:

a_Selector -

Throws:

WTPropertyVetoException

selectorValidate

private void selectorValidate(Selector a_Selector)
                       throws WTPropertyVetoException

Parameters:

a_Selector -

Throws:

WTPropertyVetoException

newIndexPolicyRule

protected static IndexPolicyRule newIndexPolicyRule(Selector sel)
                                             throws WTException

Construct an index policy rule for the given selector.

Supported API: false

Parameters:

sel -

Returns:

IndexPolicyRule

Throws:

WTException

initialize

protected void initialize(Selector sel)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

sel -

Throws:

WTException

toString

public String toString()

Returns a string representation of the rule.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Item

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Item

Returns:

int