Feature/java doc updates #803
Conversation
… since it's in the interface that gets implemented by the impl class
|
Jenkins Build failure |
|
Yes, denoting what data hub operations are logically encapsulated in the interface offering. |
| List<Flow> getLocalFlowsForEntity(String entityName, FlowType flowType); | ||
|
|
||
| /** | ||
| * Obtains a flow form a property file |
| String serialize(); | ||
|
|
||
| /** | ||
| * |
There was a problem hiding this comment.
Creates a Properties object representing the flow
| FlowRunner withSourceClient(DatabaseClient sourceClient); | ||
|
|
||
| /** | ||
| * Sets which database the flow will output to |
There was a problem hiding this comment.
Sets the database where flow output data will be persisted
| FlowRunner withThreadCount(int threadCount); | ||
|
|
||
| /** | ||
| * Sets the source client on the flow runner |
There was a problem hiding this comment.
Sets the source client on the flow runner. The source client determines which database to run against for building the envelope.
| FlowRunner withDestinationDatabase(String destinationDatabase); | ||
|
|
||
| /** | ||
| * Sets the options for the flowRunner |
There was a problem hiding this comment.
Sets the options to be passed into the xqy or sjs flow in the $options or options variables of main.
| * @param first - the minimum required string path to get the absolute path from | ||
| * @param more - additional paths submitted | ||
| * @return the absolute path of each string path provided | ||
| */ |
There was a problem hiding this comment.
this method is only used by the test project. can it be moved out of here?
| * @param flowName - the name of the flow | ||
| * @param flowType - FlowType (sjs or xqy) | ||
| * @return the directory path as a Path type | ||
| */ |
There was a problem hiding this comment.
look at where this bad boy is being used. Mostly for internal and testing. Only 1 instance in quickstart that is questionable, at best.
There was a problem hiding this comment.
Going to leave this in due to quickstart until we can figure out a better way to support the quickstart use without invoking a direct implementation.
| * Returns the disk path of the entity | ||
| * @param entityName - name of the entity as string | ||
| * @return Path of the entity | ||
| */ |
There was a problem hiding this comment.
Only used in tests. maybe move out of public interface..
|
Jenkins Build failure |
|
Jenkins Build failure |
Java doccing done to our public interface APIs