org.dlese.dpc.vocab
Class VocabNodeTermsGroups

java.lang.Object
  org.dlese.dpc.vocab.VocabNodeTermsGroups

All Implemented Interfaces:

Serializable, VocabNode

public class VocabNodeTermsGroups
extends Object
implements VocabNode, Serializable

VocabNode is a node within the vocab hierarchy of a MetadataVocab instance

Author:

Ryan Deardorff

See Also:

Serialized Form

Constructor Summary

VocabNodeTermsGroups(String name, boolean noDisplay, int groupLevel)
Constructor for the VocabNode object

Method Summary

String	getDefinition() Gets the vocab node definition
String	getDescription(PageContext page) Gets a truncated (first two sentences or first 300 characters, whichever comes first) version of a vocab descrition
boolean	getDivider() Gets the divider attribute of the vocab node (for UI list dividing)
String	getFieldId() Each vocab term has a field and a value.
int	getGroupLevel() Gets the groupLevel attribute of the VocabNode object
boolean	getHasSubList() Gets the hasSubList attribute of the VocabNode object
String	getId() Gets the encoded system Id (indexed & used in search queries)
String	getIdCompare() This is needed because Struts <logic:equal> compares strings that look like numbers without regard to leading 0s, and our ID convention causes matches between '05' and '005' to return true (they are "equal").
boolean	getIsLastInSubList() Gets the isLastInSublist attribute of the VocabNode object
String	getLabel() Gets the user interface label
String	getLabelAbbrev() Gets the abbreviated user interface label
VocabList	getList() Gets the vocab node sub-list
String	getName() Gets the Metadata name
boolean	getNoDisplay() Gets the noDisplay attribute of the vocab node (for UI suppression)
boolean	getNoDisplayOriginal() Gets the noDisplayOriginal attribute of the VocabNode object
ArrayList	getSubList() Struts equivalent of getList()--JPSs work by iterating over ArrayLists (Collections)
boolean	getWrap() Gets the wrap attribute of the vocab node (for UI table column wrapping)
void	setDefinition(String definition) Sets the vocab node definition
void	setDescription(String description) Sets the vocab node src (file for information panel)
void	setDivider(boolean divider) Sets the divider attribute of the vocab node (for UI list dividing)
void	setFieldId(String fieldId) Each vocab term has a field and a value.
void	setGroupLevel(int groupLevel) Sets the groupLevel attribute of the VocabNode object
void	setId(String id) Sets the encoded system Id (indexed & used in search queries)
void	setIsLastInSubList(boolean isLastInSubList) Sets the isLastInSublist attribute of the VocabNode object
void	setLabel(String label) Sets the user interface label
void	setLabelAbbrev(String labelAbbrev) Sets the abbreviated user interface label
void	setList(VocabList list) Sets the vocab node sub-list
void	setMetaFormat(String metaFormat) Sets the metaFormat attribute of the VocabNodeTermsGroups object
void	setName(String name) Sets the Metadata name
void	setNoDisplay(boolean noDisplay) Sets the noDisplay attribute of the vocab node (for UI suppression)
void	setNoDisplayOriginal(boolean noDisplayOriginal) Sets the noDisplay attribute of the vocab node (for UI suppression)
void	setSrc(String src) Sets the src attribute of the VocabNode object
void	setWrap(boolean wrap) Sets the wrap attribute of the vocab node (for UI table column wrapping)

Methods inherited from class java.lang.Object

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

Constructor Detail

VocabNodeTermsGroups

public VocabNodeTermsGroups(String name,
                            boolean noDisplay,
                            int groupLevel)

Constructor for the VocabNode object

Parameters:

name - metadata name

noDisplay -

groupLevel -

Method Detail

setMetaFormat

public void setMetaFormat(String metaFormat)

Sets the metaFormat attribute of the VocabNodeTermsGroups object

Specified by:

setMetaFormat in interface VocabNode

Parameters:

metaFormat - The new metaFormat value

setGroupLevel

public void setGroupLevel(int groupLevel)

Sets the groupLevel attribute of the VocabNode object

Specified by:

setGroupLevel in interface VocabNode

Parameters:

groupLevel - The new groupLevel value

getGroupLevel

public int getGroupLevel()

Gets the groupLevel attribute of the VocabNode object

Specified by:

getGroupLevel in interface VocabNode

Returns:

The groupLevel value

setFieldId

public void setFieldId(String fieldId)

Each vocab term has a field and a value. This sets the encoded system Id of this term's field.

Specified by:

setFieldId in interface VocabNode

Parameters:

fieldId - The new fieldId value

getFieldId

public String getFieldId()

Each vocab term has a field and a value. This gets the encoded system Id of this term's field.

Specified by:

getFieldId in interface VocabNode

Returns:

The fieldId value

getName

public String getName()

Gets the Metadata name

Specified by:

getName in interface VocabNode

Returns:

The name value

setName

public void setName(String name)

Sets the Metadata name

Specified by:

setName in interface VocabNode

Parameters:

name - The new name value

getId

public String getId()

Gets the encoded system Id (indexed & used in search queries)

Specified by:

getId in interface VocabNode

Returns:

The id value

setId

public void setId(String id)

Sets the encoded system Id (indexed & used in search queries)

Specified by:

setId in interface VocabNode

Parameters:

id - The new id value

getIdCompare

public String getIdCompare()

This is needed because Struts <logic:equal> compares strings that look like numbers without regard to leading 0s, and our ID convention causes matches between '05' and '005' to return true (they are "equal"). Solution: turn comparison into non-digit strings ('05Compare' vs. '005Compare') and then Struts will use alphabetical instead of numerical comparison.

Returns:

The idCompare value

getLabel

public String getLabel()

Gets the user interface label

Specified by:

getLabel in interface VocabNode

Returns:

The label value

setLabel

public void setLabel(String label)

Sets the user interface label

Specified by:

setLabel in interface VocabNode

Parameters:

label - The new label value

getLabelAbbrev

public String getLabelAbbrev()

Gets the abbreviated user interface label

Specified by:

getLabelAbbrev in interface VocabNode

Returns:

The labelAbbrev value

setLabelAbbrev

public void setLabelAbbrev(String labelAbbrev)

Sets the abbreviated user interface label

Specified by:

setLabelAbbrev in interface VocabNode

Parameters:

labelAbbrev - The new labelAbbrev value

getDefinition

public String getDefinition()

Gets the vocab node definition

Specified by:

getDefinition in interface VocabNode

Returns:

The definition value

setDefinition

public void setDefinition(String definition)

Sets the vocab node definition

Specified by:

setDefinition in interface VocabNode

Parameters:

definition - The new definition value

setSrc

public void setSrc(String src)

Sets the src attribute of the VocabNode object

Specified by:

setSrc in interface VocabNode

Parameters:

src - The new src value

getDescription

public String getDescription(PageContext page)

Gets a truncated (first two sentences or first 300 characters, whichever comes first) version of a vocab descrition

Specified by:

getDescription in interface VocabNode

Parameters:

page -

Returns:

The src value

setDescription

public void setDescription(String description)

Sets the vocab node src (file for information panel)

Specified by:

setDescription in interface VocabNode

Parameters:

description - The new description value

getList

public VocabList getList()

Gets the vocab node sub-list

Specified by:

getList in interface VocabNode

Returns:

The list value

setList

public void setList(VocabList list)

Sets the vocab node sub-list

Specified by:

setList in interface VocabNode

Parameters:

list - The new list value

getSubList

public ArrayList getSubList()

Struts equivalent of getList()--JPSs work by iterating over ArrayLists (Collections)

Specified by:

getSubList in interface VocabNode

Returns:

The list value

getHasSubList

public boolean getHasSubList()

Gets the hasSubList attribute of the VocabNode object

Specified by:

getHasSubList in interface VocabNode

Returns:

The hasSubList value

getNoDisplay

public boolean getNoDisplay()

Gets the noDisplay attribute of the vocab node (for UI suppression)

Specified by:

getNoDisplay in interface VocabNode

Returns:

The noDisplay value

setNoDisplay

public void setNoDisplay(boolean noDisplay)

Sets the noDisplay attribute of the vocab node (for UI suppression)

Specified by:

setNoDisplay in interface VocabNode

Parameters:

noDisplay - The new noDisplay value

getNoDisplayOriginal

public boolean getNoDisplayOriginal()

Gets the noDisplayOriginal attribute of the VocabNode object

Specified by:

getNoDisplayOriginal in interface VocabNode

Returns:

The noDisplayOriginal value

setNoDisplayOriginal

public void setNoDisplayOriginal(boolean noDisplayOriginal)

Sets the noDisplay attribute of the vocab node (for UI suppression)

Specified by:

setNoDisplayOriginal in interface VocabNode

Parameters:

noDisplayOriginal - The new noDisplayOriginal value

getWrap

public boolean getWrap()

Gets the wrap attribute of the vocab node (for UI table column wrapping)

Specified by:

getWrap in interface VocabNode

Returns:

The wrap value

setWrap

public void setWrap(boolean wrap)

Sets the wrap attribute of the vocab node (for UI table column wrapping)

Specified by:

setWrap in interface VocabNode

Parameters:

wrap - The new wrap value

getDivider

public boolean getDivider()

Gets the divider attribute of the vocab node (for UI list dividing)

Specified by:

getDivider in interface VocabNode

Returns:

The divider value

setDivider

public void setDivider(boolean divider)

Sets the divider attribute of the vocab node (for UI list dividing)

Specified by:

setDivider in interface VocabNode

Parameters:

divider - The new divider value

setIsLastInSubList

public void setIsLastInSubList(boolean isLastInSubList)

Sets the isLastInSublist attribute of the VocabNode object

Specified by:

setIsLastInSubList in interface VocabNode

Parameters:

isLastInSubList - The new isLastInSubList value

getIsLastInSubList

public boolean getIsLastInSubList()

Gets the isLastInSublist attribute of the VocabNode object

Specified by:

getIsLastInSubList in interface VocabNode

Returns:

The isLastInSublist value