org.frankframework.frankdoc.model

Class FrankElement

java.lang.Object

org.frankframework.frankdoc.model.FrankElement

All Implemented Interfaces:

Comparable<FrankElement>

public class FrankElement
extends Object
implements Comparable<FrankElement>

Models a Java class that can be referred to in a Frank configuration.

Author:

martijn

Field Summary

Fields

Modifier and Type	Field and Description
static String	JAVADOC_FORWARD
static String	JAVADOC_PARAMETER
static String	JAVADOC_TAG

Constructor Summary

Constructors

Constructor and Description
FrankElement(String fullName, String simpleName, boolean isAbstract) Constructor for testing purposes.

Method Summary

Modifier and Type	Method and Description
void	addXmlElementName(String elementName)
int	compareTo(FrankElement other)
List<FrankAttribute>	getAttributes(Predicate<ElementChild> filter)
<T extends ElementChild> List<T>	getChildrenOfKind(Predicate<ElementChild> selector, Class<T> kind)
List<ConfigChild>	getConfigChildren(Predicate<ElementChild> filter)
ConfigChildSet	getConfigChildSet(String roleName)
List<ConfigChild>	getConfigParents()
List<FrankAttribute>	getCumulativeAttributes(Predicate<ElementChild> selector, Predicate<ElementChild> rejector)
List<ConfigChild>	getCumulativeConfigChildren(Predicate<ElementChild> selector, Predicate<ElementChild> rejector)
List<ConfigChildSet>	getCumulativeConfigChildSets()
FrankElement	getNextAncestorThatHasChildren(Predicate<FrankElement> noChildren)
FrankElement	getNextAncestorThatHasOrRejectsAttributes(Predicate<ElementChild> selector, Predicate<ElementChild> rejector)
FrankElement	getNextAncestorThatHasOrRejectsConfigChildren(Predicate<ElementChild> selector, Predicate<ElementChild> rejector)
FrankElement	getNextPluralConfigChildrenAncestor(Predicate<ElementChild> selector, Predicate<ElementChild> rejector)
String	getTheSingleXmlElementName()
String	getTypeNameBase()
String	getXsdElementName(ElementRole elementRole)
boolean	hasFilledConfigChildSets(Predicate<ElementChild> selector, Predicate<ElementChild> rejector)
boolean	hasOnePossibleXmlElementName()
boolean	hasOrInheritsPluralConfigChildren(Predicate<ElementChild> selector, Predicate<ElementChild> rejector)
void	setAttributes(List<FrankAttribute> inputAttributes)
void	setConfigChildren(List<ConfigChild> children)
void	setParent(FrankElement parent)
String	toString()
void	walkCumulativeAttributes(CumulativeChildHandler<FrankAttribute> handler, Predicate<ElementChild> childSelector, Predicate<ElementChild> childRejector)
void	walkCumulativeConfigChildren(CumulativeChildHandler<ConfigChild> handler, Predicate<ElementChild> childSelector, Predicate<ElementChild> childRejector)

Methods inherited from class java.lang.Object

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

Field Detail

JAVADOC_PARAMETER

public static final String JAVADOC_PARAMETER

See Also:

Constant Field Values

JAVADOC_FORWARD

public static final String JAVADOC_FORWARD

See Also:

Constant Field Values

JAVADOC_TAG

public static final String JAVADOC_TAG

See Also:

Constant Field Values

Constructor Detail

FrankElement

public FrankElement(String fullName,
                    String simpleName,
                    boolean isAbstract)

Constructor for testing purposes. We want to test attribute construction in isolation, in which case we do not have a parent. TODO: Reorganize files such that this test constructor need not be public.

Method Detail

setParent

public void setParent(FrankElement parent)

getConfigParents

public List<ConfigChild> getConfigParents()

addXmlElementName

public void addXmlElementName(String elementName)

hasOnePossibleXmlElementName

public boolean hasOnePossibleXmlElementName()

getTheSingleXmlElementName

public String getTheSingleXmlElementName()

setAttributes

public void setAttributes(List<FrankAttribute> inputAttributes)

getAttributes

public List<FrankAttribute> getAttributes(Predicate<ElementChild> filter)

getChildrenOfKind

public <T extends ElementChild> List<T> getChildrenOfKind(Predicate<ElementChild> selector,
                                                          Class<T> kind)

setConfigChildren

public void setConfigChildren(List<ConfigChild> children)

getConfigChildren

public List<ConfigChild> getConfigChildren(Predicate<ElementChild> filter)

getNextAncestorThatHasChildren

public FrankElement getNextAncestorThatHasChildren(Predicate<FrankElement> noChildren)

getNextAncestorThatHasOrRejectsConfigChildren

public FrankElement getNextAncestorThatHasOrRejectsConfigChildren(Predicate<ElementChild> selector,
                                                                  Predicate<ElementChild> rejector)

getNextAncestorThatHasOrRejectsAttributes

public FrankElement getNextAncestorThatHasOrRejectsAttributes(Predicate<ElementChild> selector,
                                                              Predicate<ElementChild> rejector)

walkCumulativeAttributes

public void walkCumulativeAttributes(CumulativeChildHandler<FrankAttribute> handler,
                                     Predicate<ElementChild> childSelector,
                                     Predicate<ElementChild> childRejector)

walkCumulativeConfigChildren

public void walkCumulativeConfigChildren(CumulativeChildHandler<ConfigChild> handler,
                                         Predicate<ElementChild> childSelector,
                                         Predicate<ElementChild> childRejector)

getCumulativeConfigChildren

public List<ConfigChild> getCumulativeConfigChildren(Predicate<ElementChild> selector,
                                                     Predicate<ElementChild> rejector)

getCumulativeAttributes

public List<FrankAttribute> getCumulativeAttributes(Predicate<ElementChild> selector,
                                                    Predicate<ElementChild> rejector)

getXsdElementName

public String getXsdElementName(ElementRole elementRole)

getConfigChildSet

public ConfigChildSet getConfigChildSet(String roleName)

getCumulativeConfigChildSets

public List<ConfigChildSet> getCumulativeConfigChildSets()

hasFilledConfigChildSets

public boolean hasFilledConfigChildSets(Predicate<ElementChild> selector,
                                        Predicate<ElementChild> rejector)

getNextPluralConfigChildrenAncestor

public FrankElement getNextPluralConfigChildrenAncestor(Predicate<ElementChild> selector,
                                                        Predicate<ElementChild> rejector)

hasOrInheritsPluralConfigChildren

public boolean hasOrInheritsPluralConfigChildren(Predicate<ElementChild> selector,
                                                 Predicate<ElementChild> rejector)

getTypeNameBase

public String getTypeNameBase()

compareTo

public int compareTo(FrankElement other)

Specified by:

compareTo in interface Comparable<FrankElement>

toString

public String toString()

Overrides:

toString in class Object