net.sourceforge.ccxjc.it.model.pub.indexed.valueclass.portlet.app200
Class FilterType

java.lang.Object
  net.sourceforge.ccxjc.it.model.pub.indexed.valueclass.portlet.app200.FilterType

All Implemented Interfaces:

Serializable, Cloneable

public class FilterType
extends Object
implements Serializable, Cloneable

The filter element specifies a filter that can transform the content of portlet requests and portlet responses. Filters can access the initialization parameters declared in the deployment descriptor at runtime via the FilterConfig interface. A filter can be restricted to one or more lifecycle phases of the portlet. Valid entries for lifecycle are: ACTION_PHASE, EVENT_PHASE, RENDER_PHASE, RESOURCE_PHASE Used in: portlet-app

Java class for filterType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="filterType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}descriptionType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="display-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}display-nameType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="filter-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}filter-nameType"/>
         <element name="filter-class" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}fully-qualified-classType"/>
         <element name="lifecycle" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}string" maxOccurs="unbounded"/>
         <element name="init-param" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}init-paramType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

protected DescriptionType[]	description
protected DisplayNameType[]	displayName
protected String	filterClass
protected String	filterName
protected InitParamType[]	initParam
protected String[]	lifecycle

Constructor Summary

FilterType()
Creates a new net.sourceforge.ccxjc.it.model.pub.indexed.valueclass.portlet.app200.FilterType instance.

FilterType(FilterType o)
Creates a new net.sourceforge.ccxjc.it.model.pub.indexed.valueclass.portlet.app200.FilterType instance by copying a given instance.

Method Summary

FilterType	clone() Creates and returns a copy of this object.
void	copyDescription(DescriptionType[] source) Copies all values of property Description.
void	copyDisplayName(DisplayNameType[] source) Copies all values of property DisplayName.
void	copyInitParam(InitParamType[] source) Copies all values of property InitParam.
void	copyLifecycle(String[] source) Copies all values of property Lifecycle.
DescriptionType[]	getDescription()
DescriptionType	getDescription(int idx)
int	getDescriptionLength()
DisplayNameType[]	getDisplayName()
DisplayNameType	getDisplayName(int idx)
int	getDisplayNameLength()
String	getFilterClass() Gets the value of the filterClass property.
String	getFilterName() Gets the value of the filterName property.
InitParamType[]	getInitParam()
InitParamType	getInitParam(int idx)
int	getInitParamLength()
String[]	getLifecycle()
String	getLifecycle(int idx)
int	getLifecycleLength()
void	setDescription(DescriptionType[] values)
DescriptionType	setDescription(int idx, DescriptionType value)
void	setDisplayName(DisplayNameType[] values)
DisplayNameType	setDisplayName(int idx, DisplayNameType value)
void	setFilterClass(String value) Sets the value of the filterClass property.
void	setFilterName(String value) Sets the value of the filterName property.
void	setInitParam(InitParamType[] values)
InitParamType	setInitParam(int idx, InitParamType value)
String	setLifecycle(int idx, String value)
void	setLifecycle(String[] values)

Methods inherited from class java.lang.Object

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

Field Detail

description

protected DescriptionType[] description

displayName

protected DisplayNameType[] displayName

filterName

protected String filterName

filterClass

protected String filterClass

lifecycle

protected String[] lifecycle

initParam

protected InitParamType[] initParam

Constructor Detail

FilterType

public FilterType()

Creates a new net.sourceforge.ccxjc.it.model.pub.indexed.valueclass.portlet.app200.FilterType instance.

FilterType

public FilterType(FilterType o)

Creates a new net.sourceforge.ccxjc.it.model.pub.indexed.valueclass.portlet.app200.FilterType instance by copying a given instance.

Parameters:

o - The instance to copy or null.

Method Detail

getDescription

public DescriptionType[] getDescription()

Returns:

array of DescriptionType

getDescription

public DescriptionType getDescription(int idx)

Returns:

one of DescriptionType

getDescriptionLength

public int getDescriptionLength()

setDescription

public void setDescription(DescriptionType[] values)

Parameters:

values - allowed objects are DescriptionType

setDescription

public DescriptionType setDescription(int idx,
                                      DescriptionType value)

Parameters:

value - allowed object is DescriptionType

getDisplayName

public DisplayNameType[] getDisplayName()

Returns:

array of DisplayNameType

getDisplayName

public DisplayNameType getDisplayName(int idx)

Returns:

one of DisplayNameType

getDisplayNameLength

public int getDisplayNameLength()

setDisplayName

public void setDisplayName(DisplayNameType[] values)

Parameters:

values - allowed objects are DisplayNameType

setDisplayName

public DisplayNameType setDisplayName(int idx,
                                      DisplayNameType value)

Parameters:

value - allowed object is DisplayNameType

getFilterName

public String getFilterName()

Gets the value of the filterName property.

Returns:

possible object is String

setFilterName

public void setFilterName(String value)

Sets the value of the filterName property.

Parameters:

value - allowed object is String

getFilterClass

public String getFilterClass()

Gets the value of the filterClass property.

Returns:

possible object is String

setFilterClass

public void setFilterClass(String value)

Sets the value of the filterClass property.

Parameters:

value - allowed object is String

getLifecycle

public String[] getLifecycle()

Returns:

array of String

getLifecycle

public String getLifecycle(int idx)

Returns:

one of String

getLifecycleLength

public int getLifecycleLength()

setLifecycle

public void setLifecycle(String[] values)

Parameters:

values - allowed objects are String

setLifecycle

public String setLifecycle(int idx,
                           String value)

Parameters:

value - allowed object is String

getInitParam

public InitParamType[] getInitParam()

Returns:

array of InitParamType

getInitParam

public InitParamType getInitParam(int idx)

Returns:

one of InitParamType

getInitParamLength

public int getInitParamLength()

setInitParam

public void setInitParam(InitParamType[] values)

Parameters:

values - allowed objects are InitParamType

setInitParam

public InitParamType setInitParam(int idx,
                                  InitParamType value)

Parameters:

value - allowed object is InitParamType

copyDescription

public void copyDescription(DescriptionType[] source)

Copies all values of property Description.

Parameters:

source - The source to copy from.

Throws:

NullPointerException - if source is null.

copyDisplayName

public void copyDisplayName(DisplayNameType[] source)

Copies all values of property DisplayName.

Parameters:

source - The source to copy from.

Throws:

NullPointerException - if source is null.

copyLifecycle

public void copyLifecycle(String[] source)

Copies all values of property Lifecycle.

Parameters:

source - The source to copy from.

Throws:

NullPointerException - if source is null.

copyInitParam

public void copyInitParam(InitParamType[] source)

Copies all values of property InitParam.

Parameters:

source - The source to copy from.

Throws:

NullPointerException - if source is null.

clone

public FilterType clone()

Creates and returns a copy of this object.

Overrides:

clone in class Object

Returns:

A clone of this instance.