Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> greenstone >> gatherer >> [ cdm overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.greenstone.gatherer.cdm
Class CollectionMeta  

java.lang.Object
  org.greenstone.gatherer.cdm.CollectionMeta

All Implemented Interfaces:

java.lang.Comparable, DOMProxyListEntry

---

public class CollectionMeta

extends java.lang.Object

implements DOMProxyListEntry

This class encapsulates a single collection level metadata assignment, which constitutes a name, language and value.

Version:

2.4

---

Field Summary
private  boolean	dummy
private  org.w3c.dom.Element	element
static boolean	GREENSTONE
private  java.lang.String	text
static boolean	TEXT

 

Constructor Summary

CollectionMeta(org.w3c.dom.Element element)           Constructor.

CollectionMeta(java.lang.String name)           Constructor to create a new piece of metadata given its name.

CollectionMeta(java.lang.String name, java.lang.String language)           Constructor to create a new piece of metadata given its name.

CollectionMeta(java.lang.String name, java.lang.String language, boolean dummy)           Constructor to create a new piece of metadata given its name.

 

Method Summary
int	compareTo(java.lang.Object object)           Method to compare two collection metadata objects to calculate their respective ordering.
DOMProxyListEntry	create(org.w3c.dom.Element element)           Factory constructor.
boolean	equals(java.lang.Object object)           Method to compare two collection metadata objects for equality.
org.w3c.dom.Element	getElement()
java.lang.String	getLanguage()           Method to retrieve the value of language.
java.lang.String	getName()           Method to retrieve the value of name.
java.lang.String	getValue(boolean text_value)           Method to retrieve the value of value (well great choice of name there).
boolean	isAssigned()
boolean	isDummy()
boolean	isSpecial()           Determine if this metadata is one of the four special pieces of metadata.
void	setAssigned(boolean assigned)
void	setElement(org.w3c.dom.Element element)
void	setValue(java.lang.String raw_value)           Change the value of value.
java.lang.String	toString()           Method to print out this class as it would appear within the collection configuration file.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

TEXT

public static final boolean TEXT

See Also:

Constant Field Values

---

GREENSTONE

public static final boolean GREENSTONE

See Also:

Constant Field Values

---

dummy

private boolean dummy

---

element

private org.w3c.dom.Element element

---

text

private java.lang.String text

Constructor Detail

CollectionMeta

public CollectionMeta(org.w3c.dom.Element element)

Constructor.

---

CollectionMeta

public CollectionMeta(java.lang.String name)

Constructor to create a new piece of metadata given its name.

---

CollectionMeta

public CollectionMeta(java.lang.String name,
                      java.lang.String language)

Constructor to create a new piece of metadata given its name.

---

CollectionMeta

public CollectionMeta(java.lang.String name,
                      java.lang.String language,
                      boolean dummy)

Constructor to create a new piece of metadata given its name.

Method Detail

compareTo

public int compareTo(java.lang.Object object)

Method to compare two collection metadata objects to calculate their respective ordering.

Specified by:

compareTo in interface java.lang.Comparable

---

create

public DOMProxyListEntry create(org.w3c.dom.Element element)

Factory constructor.

Specified by:

create in interface DOMProxyListEntry

---

equals

public boolean equals(java.lang.Object object)

Method to compare two collection metadata objects for equality.

---

getElement

public org.w3c.dom.Element getElement()

Specified by:

getElement in interface DOMProxyListEntry

---

getLanguage

public java.lang.String getLanguage()

Method to retrieve the value of language.

---

getName

public java.lang.String getName()

Method to retrieve the value of name.

---

getValue

public java.lang.String getValue(boolean text_value)

Method to retrieve the value of value (well great choice of name there).

---

isAssigned

public boolean isAssigned()

Specified by:

isAssigned in interface DOMProxyListEntry

---

isDummy

public boolean isDummy()

---

isSpecial

public boolean isSpecial()

Determine if this metadata is one of the four special pieces of metadata.

---

setAssigned

public void setAssigned(boolean assigned)

Specified by:

setAssigned in interface DOMProxyListEntry

---

setElement

public void setElement(org.w3c.dom.Element element)

Specified by:

setElement in interface DOMProxyListEntry

---

setValue

public void setValue(java.lang.String raw_value)

Change the value of value.

---

toString

public java.lang.String toString()

Method to print out this class as it would appear within the collection configuration file.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> greenstone >> gatherer >> [ cdm overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---