FieldInfoReader (jOAI Java Documentation v3.3)

java.lang.Object
- org.dlese.dpc.schemedit.vocab.FieldInfoReader

```
public class FieldInfoReader
extends java.lang.Object
```
Provides access to infomormation (beyond that expressed in the metadata schema) about a metadata field, such as cataloging best practices and definitions of controlled vocabulary.
FieldInfoReader reads FieldInfo xml documents and is used by org.dlese.dpc.schemedit.autoform classes as well as MetaDataFramework instances.
Note: why doesn't this class extend the AbstractConfigReader class?

Author:

ostwald

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class FieldInfoReader.OtherPractice
Other practices have a header and a list of "practices".

Nested Classes
Modifier and Type	Class and Description
`class`	`FieldInfoReader.OtherPractice` Other practices have a header and a list of "practices".

Field Summary

Fields
Modifier and Type Field and Description

java.net.URI uri
Description of the Field

Fields
Modifier and Type	Field and Description
`java.net.URI`	`uri` Description of the Field

Constructor Summary

Constructors
Constructor and Description
`FieldInfoReader(java.lang.String path)` Constructor for the FieldInfoReader object
`FieldInfoReader(java.net.URI uri)` Constructor for the FieldInfoReader object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`applyMarkup(java.lang.String text, java.lang.String link, java.lang.String url, java.lang.String style)` Apply specified markup (url, style) to the first occurrence of a substring (link ) of the provided text.
`void`	`destroy()` Description of the Method
`java.lang.String`	`getDefinition()` Gets the definition for this field.
`org.dom4j.Document`	`getDocument()` Gets the document attribute of the FieldInfoReader object
`java.util.List`	`getDonts()` Gets the donts attribute of the FieldInfoReader object
`java.util.List`	`getDos()` Gets the dos attribute of the FieldInfoReader object
`static java.lang.String`	`getElementText(org.dom4j.Element e)` Return formatted contents for given Element, inserting hyperlink when "link" and "url" attributes are present
`java.util.List`	`getExamples()` Gets the examples attribute of the FieldInfoReader object
`java.lang.String`	`getFormat()` Get the metadata format of the framework containing this field.
`java.lang.String`	`getName()` Get the name of the field this file documents.
`java.util.List`	`getOtherPractices()` Get the list of otherPractices specified by this fields file.
`java.lang.String`	`getPath()` Get the xpath to the field this file documents.
`java.util.List`	`getPrompts()` Gets the prompts for this field.
`java.lang.String`	`getSource()` Returns URI (as String) of the source file for this FieldInfoReader
`java.util.List`	`getTermAndDeftns(java.lang.String term)` Gets a List of `TermAndDeftn` instances for specified term (usually there is only one item in the list)
`java.util.List`	`getTermList()` Gets a sorted list of vocab Terms defined by this field.
`org.apache.struts.util.LabelValueBean[]`	`getTermSelectOptions()` Build an array of terms (represented as LabelValueBean instances) to be used in a html select object.
`java.util.Collection`	`getVocabTerms()` Gets the `TermAndDeftn` instances defined for this field.
`static java.lang.String`	`replaceFirst(java.lang.String in, java.lang.String find, java.lang.String replace)` Replace first occurrance of exact match (case sensitive)
`static void`	`setDebug(boolean d)` Sets the debug attribute of the FieldInfoReader class
`java.lang.String`	`toString()` Debugging method.

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

- Field Detail
  - uri
```
public java.net.URI uri
```
    Description of the Field
- Constructor Detail
  - FieldInfoReader
```
public FieldInfoReader(java.lang.String path)
                throws java.lang.Exception
```
    Constructor for the FieldInfoReader object
    
    Parameters:
    
    path - Description of the Parameter
    
    Throws:
    
    java.lang.Exception - Description of the Exception
  - FieldInfoReader
```
public FieldInfoReader(java.net.URI uri)
                throws java.lang.Exception
```
    Constructor for the FieldInfoReader object
    
    Parameters:
    
    uri - Description of the Parameter
    
    Throws:
    
    java.lang.Exception - Description of the Exception
- Method Detail
  - getSource
```
public java.lang.String getSource()
```
    Returns URI (as String) of the source file for this FieldInfoReader
  - getDocument
```
public org.dom4j.Document getDocument()
```
    Gets the document attribute of the FieldInfoReader object
    
    Returns:
    
    The document value
  - setDebug
```
public static void setDebug(boolean d)
```
    Sets the debug attribute of the FieldInfoReader class
    
    Parameters:
    
    d - The new debug value
  - getTermAndDeftns
```
public java.util.List getTermAndDeftns(java.lang.String term)
```
    Gets a List of TermAndDeftn instances for specified term (usually there is only one item in the list)
    
    Parameters:
    
    term - Description of the Parameter
    
    Returns:
    
    The termAndDeftn value
  - getVocabTerms
```
public java.util.Collection getVocabTerms()
```
    Gets the TermAndDeftn instances defined for this field.
    
    Returns:
    
    The vocabTerms value
  - getTermList
```
public java.util.List getTermList()
```
    Gets a sorted list of vocab Terms defined by this field.
    
    Returns:
    
    The termList value
  - getTermSelectOptions
```
public org.apache.struts.util.LabelValueBean[] getTermSelectOptions()
```
    Build an array of terms (represented as LabelValueBean instances) to be used in a html select object.
    
    Returns:
    
    The termSelectOptions value as an array of
  - getPath
```
public java.lang.String getPath()
                         throws java.lang.Exception
```
    Get the xpath to the field this file documents.
    
    Returns:
    
    The path value
    
    Throws:
    
    java.lang.Exception - Description of the Exception
  - getName
```
public java.lang.String getName()
                         throws java.lang.Exception
```
    Get the name of the field this file documents.
    
    Returns:
    
    The name value
    
    Throws:
    
    java.lang.Exception - Description of the Exception
  - getFormat
```
public java.lang.String getFormat()
                           throws java.lang.Exception
```
    Get the metadata format of the framework containing this field.
    
    Returns:
    
    The format value
    
    Throws:
    
    java.lang.Exception - Description of the Exception
  - getDefinition
```
public java.lang.String getDefinition()
```
    Gets the definition for this field.
    
    Returns:
    
    The definition value
  - getPrompts
```
public java.util.List getPrompts()
```
    Gets the prompts for this field.
    
    Returns:
    
    The definition value
  - getDos
```
public java.util.List getDos()
```
    Gets the dos attribute of the FieldInfoReader object
    
    Returns:
    
    The dos value
  - getDonts
```
public java.util.List getDonts()
```
    Gets the donts attribute of the FieldInfoReader object
    
    Returns:
    
    The donts value
  - getExamples
```
public java.util.List getExamples()
```
    Gets the examples attribute of the FieldInfoReader object
    
    Returns:
    
    The examples value
  - getOtherPractices
```
public java.util.List getOtherPractices()
```
    Get the list of otherPractices specified by this fields file.
    Returns a list of OtherPractice instances, each of which has a header (e.g, "No title? Do this") and a set of "pratices".
    
    Returns:
    
    OtherPractices for this field.
  - applyMarkup
```
public static java.lang.String applyMarkup(java.lang.String text,
                                           java.lang.String link,
                                           java.lang.String url,
                                           java.lang.String style)
```
    Apply specified markup (url, style) to the first occurrence of a substring (link ) of the provided text.
    
    Parameters:
    
    text - A string of which a substring will receive formatting
    
    link - the substring to recieve formatting
    
    url - if present, provides destination for link (link becomes a hyperlink to url)
    
    style - specifies the formatting to be applied to link (bold, italic, bold and italic)
    
    Returns:
    
    text containing a marked-up substring
  - getElementText
```
public static java.lang.String getElementText(org.dom4j.Element e)
```
    Return formatted contents for given Element, inserting hyperlink when "link" and "url" attributes are present
    
    Parameters:
    
    e - Description of the Parameter
    
    Returns:
    
    The elementText value
  - replaceFirst
```
public static java.lang.String replaceFirst(java.lang.String in,
                                            java.lang.String find,
                                            java.lang.String replace)
```
    Replace first occurrance of exact match (case sensitive)
    needed to replace strings with regex pattern chars, which don't get replaced by String.replace
    
    Parameters:
    
    in - Description of the Parameter
    
    find - Description of the Parameter
    
    replace - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - toString
```
public java.lang.String toString()
```
    Debugging method.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Description of the Return Value
  - destroy
```
public void destroy()
```
    Description of the Method

Class FieldInfoReader

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

uri

Constructor Detail

FieldInfoReader

FieldInfoReader

Method Detail

getSource

getDocument

setDebug

getTermAndDeftns

getVocabTerms

getTermList

getTermSelectOptions

getPath

getName

getFormat

getDefinition

getPrompts

getDos

getDonts

getExamples

getOtherPractices

applyMarkup

getElementText

replaceFirst

toString

destroy