org.jasig.portal.layout.dlm
Class FragmentDefinition

java.lang.Object
  org.jasig.portal.layout.dlm.Evaluator
      org.jasig.portal.layout.dlm.FragmentDefinition

public class FragmentDefinition
extends Evaluator

Since:

uPortal 2.5

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Field Summary

static org.dom4j.Namespace	NAMESPACE
static String	NAMESPACE_URI

Fields inherited from class org.jasig.portal.layout.dlm.Evaluator

RCS_ID

Constructor Summary

	FragmentDefinition() No-arg constructor required by JPA/Hibernate.
	FragmentDefinition(Element e) This constructor is passed a dlm:fragment element from which this FragmentDefinition instance gathers its configuration information.
protected	FragmentDefinition(String name)

Method Summary

static String	getDefaultLayoutOwnerId()
int	getEvaluatorCount()
Class<? extends EvaluatorFactory>	getFactoryClass()
int	getIndex()
String	getName()
String	getOwnerId()
double	getPrecedence()
boolean	isApplicable(IPerson p)
boolean	isNoAudienceIncluded()
void	loadFromEelement(Element e)
void	setIndex(int index)
void	toElement(org.dom4j.Element parent) Serializes this Evaluator into the same XML format supported by dlm.xml.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_URI

public static final String NAMESPACE_URI

See Also:

Constant Field Values

NAMESPACE

public static final org.dom4j.Namespace NAMESPACE

Constructor Detail

FragmentDefinition

public FragmentDefinition()

No-arg constructor required by JPA/Hibernate.

FragmentDefinition

protected FragmentDefinition(String name)

FragmentDefinition

public FragmentDefinition(Element e)

This constructor is passed a dlm:fragment element from which this FragmentDefinition instance gathers its configuration information.

Parameters:

e - An Element representing a single in dlm.xml.

Throws:

Exception

Method Detail

loadFromEelement

public void loadFromEelement(Element e)

getName

public String getName()

getOwnerId

public String getOwnerId()

getPrecedence

public double getPrecedence()

getDefaultLayoutOwnerId

public static String getDefaultLayoutOwnerId()

getEvaluatorCount

public int getEvaluatorCount()

getIndex

public int getIndex()

setIndex

public void setIndex(int index)

isNoAudienceIncluded

public boolean isNoAudienceIncluded()

isApplicable

public boolean isApplicable(IPerson p)

Specified by:

isApplicable in class Evaluator

toElement

public void toElement(org.dom4j.Element parent)

Description copied from class: Evaluator

Serializes this Evaluator into the same XML format supported by dlm.xml. NOTE: this method will only yield usable XML if invoked on an instance of FragmentDefinition; all other subclasses will return only XML fragments.

Specified by:

toElement in class Evaluator

Parameters:

parent - The XML structure (starting with <dlm:fragment>) so far

getFactoryClass

public Class<? extends EvaluatorFactory> getFactoryClass()

Specified by:

getFactoryClass in class Evaluator