Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Ryan Berkheimer
messageapi
Commits
cc89221a
Commit
cc89221a
authored
Sep 10, 2020
by
Ryan Berkheimer
Browse files
added documentation to more classes
parent
bd4e09b1
Changes
5
Hide whitespace changes
Inline
Side-by-side
src/java/main/gov/noaa/messageapi/definitions/ContainerDefinition.java
View file @
cc89221a
...
...
@@ -71,7 +71,7 @@ public class ContainerDefinition {
private
void
parseTransformationSpec
(
Object
transformationSpec
)
throws
Exception
{
try
{
if
(
transformationSpec
instanceof
String
)
{
TransformationParser
parser
=
new
TransformationParser
(((
String
)
transformationSpec
));
TransformationParser
parser
=
new
TransformationParser
(((
String
)
transformationSpec
));
this
.
transformationMaps
=
parser
.
getTransformationMaps
();
this
.
transformations
=
parser
.
getTransformations
();
}
else
if
(
transformationSpec
instanceof
List
)
{
...
...
src/java/main/gov/noaa/messageapi/parsers/containers/CollectionParser.java
View file @
cc89221a
...
...
@@ -13,6 +13,11 @@ import gov.noaa.messageapi.utils.general.ListUtils;
import
gov.noaa.messageapi.utils.general.PathUtils
;
/**
* This class handles general collection map parsing (collections being part of the container layer).
* Currently, collection assembly can be performed using a path-as-string to the file containing a JSON map with
* a 'collections' key. The file pointed to by the path should contain a JSON map with a top-level 'collections' key
* that itself corresponds to a list of collections, each containing a required id, required array of field ids,
* optional map of classifiers, and optional array of condition ids.
* @author Ryan Berkheimer
*/
public
class
CollectionParser
extends
BaseParser
{
...
...
src/java/main/gov/noaa/messageapi/parsers/containers/MetadataParser.java
View file @
cc89221a
...
...
@@ -8,6 +8,12 @@ import gov.noaa.messageapi.parsers.BaseParser;
import
gov.noaa.messageapi.utils.general.PathUtils
;
/**
* This class handles general metadata map parsing (metadata being part of the container layer).
* Currently, metadata assembly can be performed using a path-as-string to the file containing a JSON map with
* a 'metadata' key pointing to a map. Metadata maps can contain key-value pairs of anything - they are accessible from the session
* after creation by accessing the session container interface and then the container definition, then
* using the getMetadata method.
*
* @author Ryan Berkheimer
*/
public
class
MetadataParser
extends
BaseParser
{
...
...
src/java/main/gov/noaa/messageapi/parsers/protocols/MetadataParser.java
View file @
cc89221a
...
...
@@ -8,6 +8,12 @@ import gov.noaa.messageapi.parsers.BaseParser;
import
gov.noaa.messageapi.utils.general.PathUtils
;
/**
* This class handles general metadata map parsing (metadata being part of the protocol layer).
* Currently, metadata assembly can be performed using a path-as-string to the file containing a JSON map with
* a 'metadata' key pointing to a map. Metadata maps can contain k-v pairs of anything - they are accessible from the session
* after creation by accessing the session protocol interface and then the protocol definition, then
* using the getMetadata method.
*
* @author Ryan Berkheimer
*/
public
class
MetadataParser
extends
BaseParser
{
...
...
src/java/main/gov/noaa/messageapi/parsers/schemas/MetadataParser.java
View file @
cc89221a
...
...
@@ -9,6 +9,12 @@ import gov.noaa.messageapi.utils.general.PathUtils;
/**
* This class handles general metadata map parsing (metadata being part of the schema layer).
* Currently, metadata assembly can be performed using a path-as-string to the file containing a JSON map with
* a 'metadata' key pointing to a map. Metadata maps can contain key-value pairs of anything - they are accessible from the session
* after creation by accessing the session schema interface and then the schema definition, then
* using the getMetadata method on the schema definition.
*
* @author Ryan Berkheimer
*/
public
class
MetadataParser
extends
BaseParser
{
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment