Interface for classes that can parse, format, and validate file formats for use by providers
to determine if they should process a file
- Source:
Methods
format(itemId) → {String}
Formats the itemId to what it would be resented as a fully qualified file name
Parameters:
| Name | Type | Description |
|---|---|---|
itemId |
String | The id to use |
- Source:
Returns:
A fully qualified file name
- Type
- String
isValid(fileName) → {Boolean}
Validates if the passed in file name matches the format generated by the implementing class
Parameters:
| Name | Type | Description |
|---|---|---|
fileName |
String | The filename to validate |
- Source:
Returns:
True if the format matches, false otherwise
- Type
- Boolean
parse(fileName) → {Array.String}
Parses the passed in filename to its individual parts
Parameters:
| Name | Type | Description |
|---|---|---|
fileName |
String | Parses the file name into its individual components |
- Source:
Returns:
The separate parts of the filename broken up by the implementing claessed delimiter
- Type
- Array.String