|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.property.PropertyFilter
public class PropertyFilter
Represents information, used in conjunction with one or more FilterElement
objects, for controlling which properties of a Content Engine object (and with what level of detail) to return
from the server during an object retrieval or an object refresh. Because the number and size of
properties may be large for certain objects, using a property filter to retrieve a subset
of the available properties can result in better performance by reducing the amount of data that is
retrieved from the server.
A PropertyFilter
object has the following components:
addIncludeProperty
methods. Each IncludeProperty specification is encapsulated in a
FilterElement
object, which specifies the properties to retrieve and optionally specifies the maxSize,
maxRecursion, levelDependents, and pageSize attributes. You can also set the global defaults for these attributes
using the appropriate PropertyFilter
method. You specify each property to be retrieved by its symbolic name,
or alternatively by its assigned GUID, in a space-separated list. In general, you should specify properties with their
symbolic names using PropertyNames
string constants and avoid the use of GUIDs.FilteredPropertyType
constants (for example, FilteredPropertyType.ANY_SINGLETON
, which specifies all properties of
single cardinality). You create an IncludeType specification by calling one of the addIncludeType
methods.
Each IncludeType specification is encapsulated in a FilterElement
object, which specifies the type of
property to retrieve and optionally specifies the maxSize, maxRecursion, levelDependents, and pageSize attributes.
You can also set the global defaults for these attributes using the appropriate PropertyFilter
method.addExcludeProperty
method. You specify each property to be excluded by its
symbolic name, or alternatively by its assigned GUID, in a space-separated list. In general, you should specify
properties with their symbolic names using PropertyNames
string constants and avoid the use of GUIDs.In addition, a PropertyFilter
object has attributes you can set that control how property values
are retrieved. These attributes act as global defaults for the PropertyFilter
object. You can
override each of these attributes for an individual FilterElement
object when you call an
addIncludeProperty
or addIncludeType
method. For any attribute not specified for
a FilterElement
object, the global attribute value for the PropertyFilter
object
applies. If a global value is unspecified, a default value applies.
Each of the following attributes can be set by the appropriate PropertyFilter
method:
Boolean
that specifies whether the recursion level to use
when retrieving a dependent object is the same as that of the independent object to which it belongs
(true
) or one level deeper (false
). Set this value via the
setLevelDependents
method.Integer
that specifies the maximum allowable
recursion depth to use when retrieving property relationships. This attribute determines
the level of depth at which property values are included. If unspecified, the default is zero.
Set this value via the setMaxRecursion
method.Long
that specifies the maximum size, in bytes, of content data that
can be returned when properties that hold content data are retrieved. If the amount of
content data held by retrieved properties exceeds this size, no content data is returned.
If unspecified, the default is to return all content data, no matter how large.
Set this value via the setMaxSize
method. Integer
that specifies the iterator page size for independent
object sets returned by PropertyIndependentObjectSet
properties. The iterator page size determines
how many elements of an independent object set are retrieved during each fetch. If the page size is unspecified,
by default the server uses the value of the QueryPageDefaultSize property of the ServerCacheConfiguration
object (the default for this property is 500). If the page size exceeds the value of the QueryPageMaxSize property
of the ServerCacheConfiguration
object (the default for this property is 1000), the server uses the value
of the QueryPageMaxSize property instead. Set this value via the setPageSize(int pageSize)
or setPageSize(Integer pageSize)
method.Property filter precedence rules:
PropertyFilter
object has
an IncludeType specification that specifies FilteredPropertyType.SINGLETON_STRING
and another that
specifies FilteredPropertyType.ANY_SINGLETON
), the attributes from the most specific occurrence
(in the previous example, the former specification) apply.
FilterElement
,
FilteredPropertyType
,
Serialized FormConstructor Summary | |
---|---|
PropertyFilter()
|
Method Summary | |
---|---|
void |
addExcludeProperty(java.lang.String value)
Adds one or more properties to be excluded during an object retrieval or object refresh. |
void |
addIncludeProperty(FilterElement fe)
Adds one or more properties, specified in a FilterElement object, to be included during an
object retrieval or object refresh. |
void |
addIncludeProperty(int maxRecursion,
java.lang.Long maxSize,
java.lang.Boolean levelDependents,
java.lang.String value)
Deprecated. |
void |
addIncludeProperty(int maxRecursion,
java.lang.Long maxSize,
java.lang.Boolean levelDependents,
java.lang.String value,
java.lang.Integer pageSize)
Creates a FilterElement object and adds one or more properties to be included during an
object retrieval or object refresh. |
void |
addIncludeType(FilterElement fe)
Adds properties identified by type in a FilterElement object to be included during
an object retrieval or object refresh. |
void |
addIncludeType(int maxRecursion,
java.lang.Long maxSize,
java.lang.Boolean levelDependents,
FilteredPropertyType value)
Deprecated. |
void |
addIncludeType(int maxRecursion,
java.lang.Long maxSize,
java.lang.Boolean levelDependents,
FilteredPropertyType value,
java.lang.Integer pageSize)
Creates a FilterElement object and adds properties identified by type to be included during
an object retrieval or object refresh. |
java.lang.String[] |
getExcludeProperties()
Returns an array of ExcludeProperty specifications, each of which identifies the properties to be excluded during an object retrieval or object refresh. |
FilterElement[] |
getIncludeProperties()
Returns an array of FilterElement objects, each of which identifies one or more properties
by to be included during an object retrieval or object refresh. |
FilterElement[] |
getIncludeTypes()
Returns an array of FilterElement objects, each of which identifies properties to be
included by type during an object retrieval or object refresh. |
java.lang.Boolean |
getLevelDependents()
Returns whether the recursion level that the property filter uses when retrieving a dependent object is the same as that of the independent object to which it belongs ( true ) or one level
deeper (false ). |
java.lang.Integer |
getMaxRecursion()
Returns the maximum recursion depth for the property filter to use when retrieving property relationships. |
java.lang.Long |
getMaxSize()
Returns the maximum size of content data that the property filter is allowed to retrieve. |
java.lang.Integer |
getPageSize()
Returns the iterator page size for independent object sets returned by PropertyIndependentObjectSet
properties. |
void |
setLevelDependents(boolean levelDependents)
Sets whether the recursion level that the property filter uses when retrieving a dependent object is the same as that of the independent object to which it belongs ( true ) or one level
deeper (false ). |
void |
setLevelDependents(java.lang.Boolean levelDependents)
Sets whether the recursion level that the property filter uses when retrieving a dependent object is the same as that of the independent object to which it belongs ( true ) or one level
deeper (false ). |
void |
setMaxRecursion(int maxRecursion)
Sets the maximum recursion depth for the property filter to use when retrieving property relationships. |
void |
setMaxRecursion(java.lang.Integer maxRecursion)
Sets the maximum recursion depth for the property filter to use when retrieving property relationships. |
void |
setMaxSize(java.lang.Long maxSize)
Sets the maximum size of content data that the property filter is allowed to retrieve. |
void |
setPageSize(int pageSize)
Sets the iterator page size for independent object sets returned by PropertyIndependentObjectSet
properties. |
void |
setPageSize(java.lang.Integer pageSize)
Sets the iterator page size for independent object sets returned by PropertyIndependentObjectSet
properties. |
java.lang.String |
toString()
Returns a string describing this PropertyFilter object. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PropertyFilter()
Method Detail |
---|
public java.lang.Integer getPageSize()
PropertyIndependentObjectSet
properties. The iterator page size determines how many elements of an independent object set are
retrieved from the server during each fetch. You can set this value by calling one of the setPageSize
methods of this PropertyFilter
object.
Integer
specifying the iterator page size for independent object sets.public void setPageSize(int pageSize)
PropertyIndependentObjectSet
properties. The iterator page size determines how many elements of an independent object set are
retrieved from the server during each fetch. If the filter element of a property has a value for pageSize,
the server uses the filter element's value instead of this global value. If neither the global value nor the filter
element value is specified, by default the server uses the value of the QueryPageDefaultSize property of the
ServerCacheConfiguration
object (the default for this property is 500). If the page size exceeds the
value of the QueryPageMaxSize property of the ServerCacheConfiguration
object (the default for this
property is 1000), the server uses the value of the QueryPageMaxSize property instead.
pageSize
- An int
specifying the iterator page size for independent object sets.public void setPageSize(java.lang.Integer pageSize)
PropertyIndependentObjectSet
properties. The iterator page size determines how many elements of an independent object set are
retrieved from the server during each fetch. If the filter element of a property has a value for pageSize,
the server uses the filter element's value instead of this global value. If neither the global value nor the filter
element value is specified, by default the server uses the value of the QueryPageDefaultSize property of the
ServerCacheConfiguration
object (the default for this property is 500). If the page size exceeds the
value of the QueryPageMaxSize property of the ServerCacheConfiguration
object (the default for this
property is 1000), the server uses the value of the QueryPageMaxSize property instead.
pageSize
- An Integer
that specifies the iterator page size for independent object sets.public void setMaxRecursion(int maxRecursion)
PropertyFilter
object. If the filter element of a
property has a value for maxRecursion, the server uses the filter element's value instead of this global value.
If neither the global value nor the filter element value is specified, the default is 0.
maxRecursion
- An int
that specifies the maximum allowable recursion depth for property retrieval.public void setMaxRecursion(java.lang.Integer maxRecursion)
PropertyFilter
object. If the filter element of a
property has a value for maxRecursion, the server uses the filter element's value instead of this global value.
If neither the global nor the filter element value is specified, the default is 0.
maxRecursion
- An Integer
that specifies the maximum allowable recursion depth for property retrieval.public java.lang.Integer getMaxRecursion()
PropertyFilter
object.
You can set this value by calling one of the setMaxRecursion
methods of this PropertyFilter
object.
Integer
specifying the maximum recursion depth; returns 0 if the value of the
property filter’s global maximum recursion level is null
.public void setMaxSize(java.lang.Long maxSize)
maxSize
- A Long
that specifies the maximum size (in bytes) of content data that can be
retrieved. If this size is exceeded, no content data is retrieved.
The value set is the global value for this PropertyFilter
object. If the filter element of a
property has a value for maxSize, the server uses the filter element's value instead of this global value.
If neither the global value nor the filter element value is specified, by default there is no limit on the amount of
content data that can be retrieved.public java.lang.Long getMaxSize()
PropertyFilter
object.
You can set this value by calling the setMaxSize
method of this PropertyFilter
object.
Long
specifying the maximum size (in bytes) of content data.public java.lang.Boolean getLevelDependents()
true
) or one level
deeper (false
). The returned value is a global value for this PropertyFilter
object. You can set this value by calling one of the setLevelDependents
methods of this
PropertyFilter
object.
true
if the recursion level for a dependent object is the same as that of the independent
object containing it; false
if one level deeper.public void setLevelDependents(boolean levelDependents)
true
) or one level
deeper (false
). The value set is the global value for this PropertyFilter
object.
If the filter element of a property has a value for levelDependents, the server uses the filter element's
value instead of this global value. If neither the global value nor the filter element value is specified,
the default is false
.
levelDependents
- true
if the recursion level for a dependent object
is the same as that of the independent object to which it belongs; false
if one level deeper.public void setLevelDependents(java.lang.Boolean levelDependents)
true
) or one level
deeper (false
). The value set is the global value for this PropertyFilter
object.
If the filter element of a property has a value for levelDependents, the server uses the filter element's
value instead of this global value. If neither the global value nor the filter element value is specified,
the the default is false
.
levelDependents
- true
if the recursion level for a dependent object
is the same as that of the independent object to which it belongs; false
if one level deeper.public void addIncludeProperty(FilterElement fe)
FilterElement
object, to be included during an
object retrieval or object refresh.
fe
- A FilterElement
object specifying the properties to include.public void addIncludeProperty(int maxRecursion, java.lang.Long maxSize, java.lang.Boolean levelDependents, java.lang.String value, java.lang.Integer pageSize)
FilterElement
object and adds one or more properties to be included during an
object retrieval or object refresh.
maxRecursion
- An integer that specifies the maximum allowable recursion depth for property retrieval.
This value overrides the global value set by this PropertyFilter
object.maxSize
- A Long
that specifies the maximum size of content data that can be retrieved.
This value overrides the global value set by this PropertyFilter
object.levelDependents
- true
if the recursion level for a dependent object
is the same as that of the independent object to which it belongs; false
if one level deeper.
This value overrides the global value set by this PropertyFilter
object.value
- A String
that specifies a space-separated list of the symbolic names (preferably
using PropertyNames
constants) of the properties to include.pageSize
- An Integer
that specifies the iterator page size for independent object
sets returned by PropertyIndependentObjectSet
properties. The iterator page size determines
how many elements of an independent object set are retrieved from the server during each fetch.
This value overrides the global value set by this PropertyFilter
object.public void addIncludeProperty(int maxRecursion, java.lang.Long maxSize, java.lang.Boolean levelDependents, java.lang.String value)
FilterElement
object and adds one or more properties to be included during an
object retrieval or object refresh.
maxRecursion
- An integer that specifies the maximum allowable recursion depth for property retrieval.
This value overrides the global value set by this PropertyFilter
object.maxSize
- A Long
that specifies the maximum size of content data that can be retrieved.
This value overrides the global value set by this PropertyFilter
object.levelDependents
- true
if the recursion level for a dependent object
is the same as that of the independent object to which it belongs; false
if one level deeper.
This value overrides the global value set by this PropertyFilter
object.value
- A String
that specifies a space-separated list of the symbolic names (preferably
using PropertyNames
constants) of the properties to include.public FilterElement[] getIncludeProperties()
FilterElement
objects, each of which identifies one or more properties
by to be included during an object retrieval or object refresh.
FilterElement
objects. If this PropertyFilter
object does not
have any IncludeProperty specifications, this method returns an empty array.public void addExcludeProperty(java.lang.String value)
value
- A String
that specifies a space-separated list of the symbolic names (preferably
using PropertyNames
constants) of the properties to exclude.public java.lang.String[] getExcludeProperties()
String
array specifying the properties to be excluded. If this PropertyFilter
object does not have any ExcludeProperty specifications defined, this method returns an empty array.public void addIncludeType(FilterElement fe)
FilterElement
object to be included during
an object retrieval or object refresh. The property type can be specified in the FilterElement
object by a single FilteredPropertyType
constant or a space-separated list of type specifiers.
fe
- A FilterElement
object specifying the type of properties to include.public void addIncludeType(int maxRecursion, java.lang.Long maxSize, java.lang.Boolean levelDependents, FilteredPropertyType value, java.lang.Integer pageSize)
FilterElement
object and adds properties identified by type to be included during
an object retrieval or object refresh.
maxRecursion
- An int
that specifies the maximum allowable recursion depth for property retrieval.
This value overrides the global value set by this PropertyFilter
object.maxSize
- A Long
that specifies the maximum size of content data that can be retrieved.
This value overrides the global value set by this PropertyFilter
object.levelDependents
- true
if the recursion level for a dependent object
is the same as that of the independent object to which it belongs; false
if one level deeper.
This value overrides the global value set by this PropertyFilter
object.value
- A FilteredPropertyType
constant specifying the type of the properties to include.pageSize
- An Integer
that specifies the iterator page size for independent object
sets returned by PropertyIndependentObjectSet
properties. The iterator page size determines
how many elements of an independent object set are retrieved from the server during each fetch.
This value overrides the global value set by this PropertyFilter
object.public void addIncludeType(int maxRecursion, java.lang.Long maxSize, java.lang.Boolean levelDependents, FilteredPropertyType value)
FilterElement
object and adds properties identified by type to be included during
an object retrieval or object refresh.
maxRecursion
- An int
that specifies the maximum allowable recursion depth for property retrieval.
This value overrides the global value set by this PropertyFilter
object.maxSize
- A Long
that specifies the maximum size of content data that can be retrieved.
This value overrides the global value set by this PropertyFilter
object.levelDependents
- true
if the recursion level for a dependent object
is the same as that of the independent object to which it belongs; false
if one level deeper.
This value overrides the global value set by this PropertyFilter
object.value
- A FilteredPropertyType
constant specifying the type of the properties to include.public FilterElement[] getIncludeTypes()
FilterElement
objects, each of which identifies properties to be
included by type during an object retrieval or object refresh.
FilterElement
objects. If this PropertyFilter
object does not
have any IncludeType specifications, this method returns an empty array.public java.lang.String toString()
PropertyFilter
object. The string includes the object's class
name and its maxRecursion, maxSize, pageSize, and levelDependents attributes. In addition, the string includes
the object's list of included properties, list of included property types, and list of excluded properties.
toString
in class java.lang.Object
String
that represents this PropertyFilter
object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |