DisplayHierarchyNode (elda-lda 1.3.0-SNAPSHOT API)

java.lang.Object
- com.epimorphics.lda.renderers.common.DisplayHierarchyNode

```
public class DisplayHierarchyNode
extends Object
```
A node in the unfolded display hierarchy starting at the item roots. In the case of properties with multiple values, a node may be a group that has siblings.

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_RELATED_LINK_LABEL_LENGTH
Maximum label length in a related link

static String SORT_BY_FORMAT

Fields
Modifier and Type	Field and Description
`static int`	`MAX_RELATED_LINK_LABEL_LENGTH` Maximum label length in a related link
`static String`	`SORT_BY_FORMAT`

Constructor Summary

Constructors
Constructor and Description
`DisplayHierarchyNode(PropertyPath pathTo, DisplayHierarchyNode parent, DisplayRdfNode rdfNode, ShortNameRenderer shortNameRenderer)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addHint(String hint)` Add a new hint to this node's list of display hints
`void`	`addSibling(DisplayHierarchyNode sibling)` Add a sibling node to this node
`List<DisplayHierarchyNode>`	`children()`
`Set<PropertyPath>`	`explicitPaths()`
`List<DisplayHierarchyNode>`	`extractByPredicate(List<Object> properties)` Extract the given properties, so that they can be treated in a particular way by the renderer.
`List<DisplayHierarchyNode>`	`extractByPredicate(Object... properties)` Extract the given properties, so that they can be treated in a particular way by the renderer.
`boolean`	`findAncestor(DisplayRdfNode resource)`
`protected Link`	`generateLink(String paramName, String paramNameLabel, String paramValue, String paramValueLabel, String rel, String hint, boolean set, Page page)` Generate a link to an adjacent point in API space, by changing the value of a parameter of the URI.
`protected Link`	`generateSortLink(String paramName, String paramHTML, String hint, boolean asc, Page page)` Generate a link to an adjacent point in API space by adding or removing a sort parameter.
`String`	`getLexicalForm()`
`String`	`getName()`
`String`	`getURI()`
`Object`	`getValue()`
`boolean`	`hasAllProperties(List<Object> properties)`
`boolean`	`hasAllProperties(Object... properties)`
`boolean`	`hasHint(String hint)`
`boolean`	`hasSiblings()`
`String`	`hintsString()`
`protected int`	`indexOfChildProperty(com.hp.hpl.jena.rdf.model.Property prop)`
`boolean`	`isAnon()`
`boolean`	`isLeaf(DisplayHierarchy.DisplayHierarchyContext context)` A node is a leaf of the hierarchy if any of the following apply: it is a literal it has already occurred among its own ancestors (ie is a loop) it is not a top-level root node, has been previously expanded and is not on an explicit property path
`boolean`	`isList()`
`boolean`	`isLiteral()`
`boolean`	`isLoop()`
`boolean`	`isOnExplicitPath()`
`boolean`	`isResource()`
`boolean`	`isRoot()`
`boolean`	`isSimpleResource()` Return true if this node is a simple resource node: that is, it is a resource, and has no properties other than either `rdfs:label` or `skos:prefLabel`.
`DisplayHierarchyNode`	`parent()`
`PropertyPath`	`pathTo()`
`void`	`pullToStart(List<Object> properties)` Promote the given properties to the front of the list of properties attached to this node.
`void`	`pullToStart(Object... properties)` Promote the given properties to the front of the list of properties attached to this node.
`DisplayRdfNode`	`rdfNode()`
`List<Link>`	`relatedLinks()`
`String`	`relatedLinksHTML()`
`List<DisplayHierarchyNode>`	`siblings()`
`com.epimorphics.rdfutil.RDFNodeWrapper`	`terminalLink()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SORT_BY_FORMAT
```
public static final String SORT_BY_FORMAT
```
    See Also:
    Constant Field Values
  - MAX_RELATED_LINK_LABEL_LENGTH
```
public static final int MAX_RELATED_LINK_LABEL_LENGTH
```
    Maximum label length in a related link
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DisplayHierarchyNode
```
public DisplayHierarchyNode(PropertyPath pathTo,
                    DisplayHierarchyNode parent,
                    DisplayRdfNode rdfNode,
                    ShortNameRenderer shortNameRenderer)
```
- Method Detail
  - pathTo
```
public PropertyPath pathTo()
```
    Returns:
    The path to this node
  - terminalLink
```
public com.epimorphics.rdfutil.RDFNodeWrapper terminalLink()
```
    Returns:
    The RDF predicate linking from the parent node to this one
  - isOnExplicitPath
```
public boolean isOnExplicitPath()
```
    Returns:
    True if this node is explicitly on a property path
  - explicitPaths
```
public Set<PropertyPath> explicitPaths()
```
    Returns:
    The explicit property path that this expansion is following
  - parent
```
public DisplayHierarchyNode parent()
```
    Returns:
    The parent node
  - isRoot
```
public boolean isRoot()
```
    Returns:
    True if this node is a root of the hierarchy
  - rdfNode
```
public DisplayRdfNode rdfNode()
```
    Returns:
    The RDF node that this hierarchy node is presenting
  - isLoop
```
public boolean isLoop()
```
    Returns:
    True if this resource has already been seen on this branch
  - findAncestor
```
public boolean findAncestor(DisplayRdfNode resource)
```
    Returns:
    True if this node's RDF node equals resource, or if any of my ancestors do
  - isLeaf
```
public boolean isLeaf(DisplayHierarchy.DisplayHierarchyContext context)
```
    A node is a leaf of the hierarchy if any of the following apply:
    - it is a literal
    - it has already occurred among its own ancestors (ie is a loop)
    - it is not a top-level root node, has been previously expanded and is not on an explicit property path
    Parameters:
    context - The current context, which contains the list of seen nodes
    
    Returns:
    True if this is a leaf node of this hierarchy
  - children
```
public List<DisplayHierarchyNode> children()
```
    Returns:
    The list of children of this node.
  - addSibling
```
public void addSibling(DisplayHierarchyNode sibling)
```
    Add a sibling node to this node
  - siblings
```
public List<DisplayHierarchyNode> siblings()
```
    Returns:
    A list of the siblings of this node, which may be empty but is not null
  - hasSiblings
```
public boolean hasSiblings()
```
    Returns:
    True if this node has at least one sibling
  - addHint
```
public void addHint(String hint)
```
    Add a new hint to this node's list of display hints
  - hintsString
```
public String hintsString()
```
    Returns:
    The list of hints joined into a string
  - hasHint
```
public boolean hasHint(String hint)
```
    Returns:
    True if the given string is one of this node's hints
  - isSimpleResource
```
public boolean isSimpleResource()
```
    Return true if this node is a simple resource node: that is, it is a resource, and has no properties other than either rdfs:label or skos:prefLabel.
    
    Returns:
    True for nodes which can be displayed very simply
  - relatedLinksHTML
```
public String relatedLinksHTML()
```
    Returns:
    An HTML marked-up string of related links
  - relatedLinks
```
public List<Link> relatedLinks()
```
    Returns:
    A list of the related links to this node
  - hasAllProperties
```
public boolean hasAllProperties(Object... properties)
```
    Returns:
    True if this node has all of the given properties
  - hasAllProperties
```
public boolean hasAllProperties(List<Object> properties)
```
    Returns:
    True if this node has all of the given properties
  - pullToStart
```
public void pullToStart(Object... properties)
```
    Promote the given properties to the front of the list of properties attached to this node. For example, if the children of this node are a,b,c,d,e, and we pullToStart(c,d,f) the children of the node will become c,d,a,b,e
    
    Parameters:
    properties - RDF properties which will identify the children of this node to move to the front of the children list. Order within the properties is preserved.
  - pullToStart
```
public void pullToStart(List<Object> properties)
```
    Promote the given properties to the front of the list of properties attached to this node. For example, if the children of this node are a,b,c,d,e, and we pullToStart(c,d,f) the children of the node will become c,d,a,b,e
    
    Parameters:
    properties - RDF properties which will identify the children of this node to move to the front of the children list. Order within the properties is preserved.
  - extractByPredicate
```
public List<DisplayHierarchyNode> extractByPredicate(Object... properties)
```
    Extract the given properties, so that they can be treated in a particular way by the renderer.
    
    Parameters:
    properties - One or more RDF properties as Property objects or qName strings
    
    Returns:
    A non-null but possibly empty list of the child nodes of this node that are connected to this node by one of the given properties.
  - extractByPredicate
```
public List<DisplayHierarchyNode> extractByPredicate(List<Object> properties)
```
    Extract the given properties, so that they can be treated in a particular way by the renderer.
    
    Parameters:
    properties - One or more RDF properties as Property objects or qName strings
    
    Returns:
    A non-null but possibly empty list of the child nodes of this node that are connected to this node by one of the given properties.
  - isResource
```
public boolean isResource()
```
    See Also:
    RDFNodeWrapper.isResource()
  - isLiteral
```
public boolean isLiteral()
```
    See Also:
    RDFNodeWrapper.isLiteral()
  - isAnon
```
public boolean isAnon()
```
    See Also:
    RDFNodeWrapper.isAnon()
  - isList
```
public boolean isList()
```
    See Also:
    RDFNodeWrapper.isList()
  - getLexicalForm
```
public String getLexicalForm()
```
    See Also:
    RDFNodeWrapper.getLexicalForm()
  - getName
```
public String getName()
```
    See Also:
    RDFNodeWrapper.getName()
  - getValue
```
public Object getValue()
```
    See Also:
    RDFNodeWrapper.getValue()
  - getURI
```
public String getURI()
```
    See Also:
    RDFNodeWrapper.getURI()
  - generateLink
```
protected Link generateLink(String paramName,
                String paramNameLabel,
                String paramValue,
                String paramValueLabel,
                String rel,
                String hint,
                boolean set,
                Page page)
```
    Generate a link to an adjacent point in API space, by changing the value of a parameter of the URI. By default, this is an addition to the URI, but if the parameter is already set, then it becomes a remove operation.
    
    Parameters:
    paramName - The name of the parameter to change
    paramNameLabel - Presentation form of paramName
    paramValue - The value to change
    paramValueLabel - The value on the label to show to the user
    rel - The relationship of the parameter value to the new state
    hint - CSS hint
    set - If true, set the value rather than add it (see EldaURL.OPERATION)
    page - The current page object
    
    Returns:
    The new link
  - generateSortLink
```
protected Link generateSortLink(String paramName,
                    String paramHTML,
                    String hint,
                    boolean asc,
                    Page page)
```
    Generate a link to an adjacent point in API space by adding or removing a sort parameter. If the URL already includes a sort on "foo", then adding a sort on "-foo" will remove the "foo" sort, and vice-versa.
    
    Parameters:
    paramName - The name of the parameter to change
    paramHTML - The parameter's name in HTML form
    hint - CSS hint
    asc - If true, sort ascending
    page - The current page object
    
    Returns:
    The new link
  - indexOfChildProperty
```
protected int indexOfChildProperty(com.hp.hpl.jena.rdf.model.Property prop)
```
    Returns:
    The index of the child node with the given property, or -1 if not found

Class DisplayHierarchyNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SORT_BY_FORMAT

MAX_RELATED_LINK_LABEL_LENGTH

Constructor Detail

DisplayHierarchyNode

Method Detail

pathTo

terminalLink

isOnExplicitPath

explicitPaths

parent

isRoot

rdfNode

isLoop

findAncestor

isLeaf

children

addSibling

siblings

hasSiblings

addHint

hintsString

hasHint

isSimpleResource

relatedLinksHTML

relatedLinks

hasAllProperties

hasAllProperties

pullToStart

pullToStart

extractByPredicate

extractByPredicate

isResource

isLiteral

isAnon

isList

getLexicalForm

getName

getValue

getURI

generateLink

generateSortLink

indexOfChildProperty