public class FilterElement
extends java.lang.Object
implements java.io.Serializable
PropertyFilter
object,
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.
In order to create a property filter, a FilterElement
object must be
created for each set of properties that you wish to add. First, create a PropertyFilter
object, then call its addIncludeProperty
or addIncludeType
methods to specify one or more FilterElement
objects. Depending on
which PropertyFilter
method you choose to use, you can either create a FilterElement
object directly and pass it as a method parameter or let the server create the
object for you based on the values that you provide for the method parameters.
A FilterElement
object can specify one or more properties, either
by identifier or by type. When specifying properties by identifier, a FilterElement
object is created by setting the value
parameter of the appropriate constructor to a
space-separated list of symbolic names. When specifying properties by type,
a FilterElement
object is created by setting the value
parameter of the appropriate constructor to a space-separated list of type specifiers or a
FilteredPropertyType
constant.
In addition, a FilterElement
object also has attributes you can set that
control how property values are retrieved. These attributes override any global attributes that
may be specified by the associated PropertyFilter
object. If an attribute is not
set in a FilterElement
object, the attribute's global value in the PropertyFilter
object will be used instead. If a global value is unspecified, a default value applies.
The following attributes are set by the parameters of a FilterElement
constructor:
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
).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.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.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. PropertyFilter
,
FilteredPropertyType
,
Serialized FormConstructor and Description |
---|
FilterElement(java.lang.Integer maxRecursion,
java.lang.Long maxSize,
java.lang.Boolean levelDependents,
FilteredPropertyType value)
Deprecated.
|
FilterElement(java.lang.Integer maxRecursion,
java.lang.Long maxSize,
java.lang.Boolean levelDependents,
FilteredPropertyType value,
java.lang.Integer pageSize)
Creates a
FilterElement object that specifies, by type,
which properties to retrieve from the server. |
FilterElement(java.lang.Integer maxRecursion,
java.lang.Long maxSize,
java.lang.Boolean levelDependents,
java.lang.String value)
Deprecated.
|
FilterElement(java.lang.Integer maxRecursion,
java.lang.Long maxSize,
java.lang.Boolean levelDependents,
java.lang.String value,
java.lang.Integer pageSize)
Creates a
FilterElement object that specifies, either by identifier
or by type, one or more properties to retrieve from the server. |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getLevelDependents()
Returns whether the recursion level to use when retrieving a dependent object returned by
a property specified by this
FilterElement 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 to use when retrieving property relationships
specified by this
FilterElement object. |
java.lang.Long |
getMaxSize()
Returns the maximum size of the content data that can be returned when properties
that hold content data specified by this
FilterElement object are retrieved. |
java.lang.Integer |
getPageSize()
Returns the iterator page size for independent object sets returned by
PropertyIndependentObjectSet
properties specified by this FilterElement object. |
java.lang.String |
getValue()
Returns a space-separated list of one or more property identifiers or a space-separated
list of one or more property types that are specified by this
FilterElement object. |
java.lang.String |
toString()
Returns a string describing this
FilterElement object, including its class name,
maximum recursion number, maximum size, number of level dependents, and its value. |
public FilterElement(java.lang.Integer maxRecursion, java.lang.Long maxSize, java.lang.Boolean levelDependents, java.lang.String value, java.lang.Integer pageSize)
FilterElement
object that specifies, either by identifier
or by type, one or more properties to retrieve from the server.maxRecursion
- A zero-based Integer
that specifies the maximum
allowable recursion depth to use when retrieving property relationships.maxSize
- A 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.levelDependents
- 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
).value
- A String
specifying one or more properties to retrieve. You can either
specify a space-separated list of property names or property types, but not both. To specify
property names, construct a space-separated list of each property's symbolic name (preferably
using PropertyNames
constants). Although you can alternatively specify a property by its
assigned GUID, it is not recommended.
To specify property types, construct a space-separated list in which each property type is in one of
the following formats (note that you can mix formats within the same string):
PropertyBoolean
properties.PropertyBinary
properties.PropertyDateTime
properties.PropertyFloat64
properties.PropertyId
properties.PropertyInteger32
properties.PropertyEngineObject
properties.PropertyString
properties.PropertyContent
properties.PropertyBooleanList
properties.PropertyBinaryList
properties.PropertyDateTimeList
properties.PropertyFloat64List
properties.PropertyIdList
properties.PropertyInteger32List
properties.PropertyDependentObjectList
properties.PropertyStringList
properties.PropertyIndependentObjectSet
properties.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.public FilterElement(java.lang.Integer maxRecursion, java.lang.Long maxSize, java.lang.Boolean levelDependents, java.lang.String value)
FilterElement
object that specifies, either by identifier
or by type, one or more properties to retrieve from the server.maxRecursion
- A zero-based Integer
that specifies the maximum
allowable recursion depth to use when retrieving property relationships.
If unspecified, the default is zero.maxSize
- A 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.levelDependents
- 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
).value
- A String
specifying one or more properties to retrieve. You can either
specify a space-separated list of property names or property types, but not both. To specify
property names, construct a space-separated list of each property's symbolic name (preferably
using PropertyNames
constants). Although you can alternatively specify a property by its
assigned GUID, it is not recommended.
To specify property types, construct a space-separated list in which each property type is in one of
the following formats (note that you can mix formats within the same string):
PropertyBoolean
properties.PropertyBinary
properties.PropertyDateTime
properties.PropertyFloat64
properties.PropertyId
properties.PropertyInteger32
properties.PropertyEngineObject
properties.PropertyString
properties.PropertyContent
properties.PropertyBooleanList
properties.PropertyBinaryList
properties.PropertyDateTimeList
properties.PropertyFloat64List
properties.PropertyIdList
properties.PropertyInteger32List
properties.PropertyDependentObjectList
properties.PropertyStringList
properties.PropertyIndependentObjectSet
properties.public FilterElement(java.lang.Integer maxRecursion, java.lang.Long maxSize, java.lang.Boolean levelDependents, FilteredPropertyType value, java.lang.Integer pageSize)
FilterElement
object that specifies, by type,
which properties to retrieve from the server.maxRecursion
- A zero-based Integer
that specifies the maximum
allowable recursion depth to use when retrieving property relationships.maxSize
- A Long
that specifies the maximum size of content data, in bytes,
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.levelDependents
- 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
).value
- A FilteredPropertyType
constant specifying the type of
properties to retrieve.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.public FilterElement(java.lang.Integer maxRecursion, java.lang.Long maxSize, java.lang.Boolean levelDependents, FilteredPropertyType value)
FilterElement
object that specifies, by type,
which properties to retrieve from the server.maxRecursion
- A zero-based Integer
that specifies the maximum
allowable recursion depth to use when retrieving property relationships.maxSize
- A Long
that specifies the maximum size of content data, in bytes,
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.levelDependents
- 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
).value
- A FilteredPropertyType
constant specifying the type of
properties to retrieve.public java.lang.Integer getMaxRecursion()
FilterElement
object.Integer
specifying the maximum recursion depth; returns 0
if the value of the recursion level is null
.public java.lang.Long getMaxSize()
FilterElement
object are retrieved.
If the amount of content data held by retrieved properties exceeds this size,
no content data is returned.Long
specifying the maximum size (in bytes) of content data.public java.lang.Boolean getLevelDependents()
FilterElement
object is the
same as that of the independent object to which it belongs (true
)
or one level deeper (false
).true
if the recursion level for a dependent object is the same as that of the independent
object containing it; false
if it is one level deeper.public java.lang.String getValue()
FilterElement
object.String
specifying the properties or type of properties.public java.lang.Integer getPageSize()
PropertyIndependentObjectSet
properties specified by this FilterElement
object. The iterator page size determines how many elements of an independent object set are
retrieved from the server during each fetch.Integer
specifying the iterator page size for independent object sets.public java.lang.String toString()
FilterElement
object, including its class name,
maximum recursion number, maximum size, number of level dependents, and its value.toString
in class java.lang.Object
String
that represents this FilterElement
object.© Copyright IBM Corporation 2006, 2015. All rights reserved.