org.apache.oodt.pcs.listing

Class ListingConf

java.lang.Object

org.apache.oodt.pcs.listing.ListingConf

public class ListingConf
extends Object

The configuration for the PCSLongLister.

Version:

$Revision$

Author:

mattmann

Constructor Summary

Constructors

Constructor and Description
ListingConf(File file) Constructs a new ListingConf with the given File.

Method Summary

Modifier and Type	Method and Description
List<String>	getExcludedTypes() Returns the set of excluded product types.
String	getHeaderColDisplayName(String headerColKey) Returns the display name for a particular header col key.
List<String>	getHeaderColKeys() Gets the set of Header column met key names for the long lister.
boolean	isCollectionField(String colName) Tester method to determine if an output field is a collection field, and needs special handling.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListingConf

public ListingConf(File file)
            throws FileNotFoundException,
                   InstantiationException

Constructs a new ListingConf with the given File.

Parameters:

file - The configuration file.

Throws:

FileNotFoundException - If the config file cannot be found.

InstantiationException - If there is some error reading the config file.

Method Detail

getExcludedTypes

public List<String> getExcludedTypes()

Returns the set of excluded product types.

Returns:

The set of excluded product types.

getHeaderColKeys

public List<String> getHeaderColKeys()

Gets the set of Header column met key names for the long lister.

Returns:

The set of Header column met key names for the long lister.

getHeaderColDisplayName

public String getHeaderColDisplayName(String headerColKey)

Returns the display name for a particular header col key.

Parameters:

headerColKey - The header col met key to look up the display name for.

Returns:

The header col met key's display name.

isCollectionField

public boolean isCollectionField(String colName)

Tester method to determine if an output field is a collection field, and needs special handling.

Parameters:

colName - The field name to check.

Returns:

True if it's a collection field, false if not, or if the collection fields group doesn't exist in the conf.