DLESE Tools
v1.6.0

org.dlese.dpc.schemedit.vocab.layout
Class VocabLayoutConfig

java.lang.Object
  extended by org.dlese.dpc.schemedit.vocab.layout.VocabLayoutConfig

public class VocabLayoutConfig
extends Object

Populates the a groupInfoMap by reading from a file specified in Framework config file (with name ending in "fields-list.xml"). The fields-list file contains a list of relative URIs that can be used to calculate the absolute URI to the individual fields files.

E.g.,

Author:
ostwald


Field Summary
protected  String configPath
           
protected  HashMap map
           
 
Constructor Summary
VocabLayoutConfig()
          Constructor for the VocabLayoutConfig object
VocabLayoutConfig(File configIndexFile)
          Constructor for the VocabLayoutConfig object
VocabLayoutConfig(String configIndexPath)
           
 
Method Summary
 List getAllVocabLayout()
          Gets all the VocabLayouts as a list.
 List getFields()
          Gets all the fields (xpaths) having VocabLayouts
 URI getFieldsFileUri(String relativePath)
          Gets an absolute URI be resolving a baseUri (pointing to the groups-list file) and a relativePath.
 Set getKeySet()
          Gets the keySet attribute of the VocabLayoutMap object
 VocabLayout getVocabLayout(String xpath)
           
 boolean hasVocabLayout(String xpath)
          Returns true if there is a VocabLayout present for the specified xpath.
 void init()
          Read a listing of URIs Fields files from directoryUri and then loads each of the listed files as VocabLayout objects, which are stored in a map.
static void main(String[] args)
          Read a set of groups files
protected static void prtln(String s)
          Output a line of text to standard out, with datestamp, if debug is set to true.
 void putVocabLayout(String xpath, VocabLayout reader)
          Add a VocabLayout to the map.
 void reload()
          Reload all the VocabLayouts in the map
 void removeVocabLayout(String xpath)
           
static void setDebug(boolean d)
           
 String toString()
          Description of the Method
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

map

protected HashMap map

configPath

protected String configPath
Constructor Detail

VocabLayoutConfig

public VocabLayoutConfig()
Constructor for the VocabLayoutConfig object


VocabLayoutConfig

public VocabLayoutConfig(String configIndexPath)

VocabLayoutConfig

public VocabLayoutConfig(File configIndexFile)
Constructor for the VocabLayoutConfig object

Parameters:
uri - NOT YET DOCUMENTED
Method Detail

putVocabLayout

public void putVocabLayout(String xpath,
                           VocabLayout reader)
Add a VocabLayout to the map.

Parameters:
xpath - Description of the Parameter
reader - Description of the Parameter

getVocabLayout

public VocabLayout getVocabLayout(String xpath)

removeVocabLayout

public void removeVocabLayout(String xpath)

getKeySet

public Set getKeySet()
Gets the keySet attribute of the VocabLayoutMap object

Returns:
The keySet value

reload

public void reload()
            throws Exception
Reload all the VocabLayouts in the map

Throws:
Exception - Description of the Exception

getAllVocabLayout

public List getAllVocabLayout()
Gets all the VocabLayouts as a list.

Returns:
a List of VocabLayouts

getFields

public List getFields()
Gets all the fields (xpaths) having VocabLayouts

Returns:
a list of xpaths to Fields

hasVocabLayout

public boolean hasVocabLayout(String xpath)
Returns true if there is a VocabLayout present for the specified xpath.

Parameters:
xpath - Description of the Parameter
Returns:
Description of the Return Value

toString

public String toString()
Description of the Method

Overrides:
toString in class Object
Returns:
Description of the Return Value

init

public void init()
          throws Exception
Read a listing of URIs Fields files from directoryUri and then loads each of the listed files as VocabLayout objects, which are stored in a map.

Throws:
Exception - Description of the Exception

getFieldsFileUri

public URI getFieldsFileUri(String relativePath)
                     throws Exception
Gets an absolute URI be resolving a baseUri (pointing to the groups-list file) and a relativePath.

The first two parts of the relative path form a format, version key. E.g. for relativePath "annotation/1.0.00/fields/annotation-anno-fields-en-us.xml" the key is "annotation", "1.0.00". To form an absolute fieldsFileUri, the part of the baseUri above the key are joined with the relativePath.

Exceptions are thrown if the relativePath does not contain a key, or if the baseUri does not contain the key specified by the relativePath.

Parameters:
baseUri - baseUri pointing to a fields-list file
relativePath - a relative path containing a framework, version key and the name of the fields file.
Returns:
an absolute groupsFileUri
Throws:
Exception - if absoluteFieldsFileUri cannot be computed

main

public static void main(String[] args)
                 throws Exception
Read a set of groups files

Parameters:
args - The command line arguments
Throws:
Exception - Description of the Exception

setDebug

public static void setDebug(boolean d)

prtln

protected static void prtln(String s)
Output a line of text to standard out, with datestamp, if debug is set to true.

Parameters:
s - The String that will be output.

DLESE Tools
v1.6.0