Package hec.externalplugin
Class ExternalDataType
java.lang.Object
hec.externalplugin.ExternalDataType
- All Implemented Interfaces:
AsciiSerializable,FieldAccessor,Serializable
ExternalDataType holds the plugin name, source type, and the data type
The plugin name is the plugin that can search for data of this ExternalDataType
The source type is generally the file type that the data comes from,
but could be anything else represented as a string
The data type is a string representing the type of data supported within the source
Example: Plugin to provide a range of cells from an Excel spreadsheet
source type = "Excel"
data type = "Range"
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleangets the type of data within the sourcegetFieldObject(Field fld) This method allows access to java.lang.reflect.Field objects within the implementing class.gets the name of the plugin that supports this ExternalDataTypegets the name of the source typeinthashCode()voidsetDataType(String dataType) sets the type of data within the sourcebooleansetFieldObject(Field fld, Object fobj) This allows access to fields withing the implementing object to set there data.voidsetPluginName(String pluginName) Sets the name of the plugin that supports this ExternalDataTypevoidsetSourceType(String sourceType) sets the name of the source typetoString()
-
Constructor Details
-
ExternalDataType
public ExternalDataType()
-
-
Method Details
-
setPluginName
Sets the name of the plugin that supports this ExternalDataType- Parameters:
pluginName-
-
getPluginName
gets the name of the plugin that supports this ExternalDataType- Returns:
-
setSourceType
sets the name of the source type- Parameters:
sourceType-
-
getSourceType
gets the name of the source type- Returns:
-
getDataType
gets the type of data within the source- Returns:
-
setDataType
sets the type of data within the source- Parameters:
dataType-
-
toString
-
getFieldObject
Description copied from interface:FieldAccessorThis method allows access to java.lang.reflect.Field objects within the implementing class.- Specified by:
getFieldObjectin interfaceFieldAccessor- Parameters:
fld- The field to get.- Returns:
- The data object that is stored in the given field
-
setFieldObject
Description copied from interface:FieldAccessorThis allows access to fields withing the implementing object to set there data.- Specified by:
setFieldObjectin interfaceFieldAccessor- Parameters:
fld- The java field object representing the member field to be setfobj- The data to set in that field- Returns:
- returns true if successful
-
equals
-
hashCode
public int hashCode()
-