15. Open API Enhancements (Revision #77)

Open APIs enable developers to write scripts that access the functionality of Aqua Data Studio to create custom solutions and tasks that fall outside of the product's GUI restrictions. This includes current functionality around database access, database schema DDL generation, compare tools, version control, data pivoting, charts and much more. We have introduced new functionalities in Aqua Data Studio v10.0 and have made them accessible via the Open APIs. The list includes two new chart types, 3D Line Chart and the Ichimoku Cloud Chart, Move Series Functionality, Series Functions on Range of values, AxisRenderer, Chart Opacity and Legend and Chart Title Positions. Other additions include reading and writing in Excel 2007 format, enhancements to AQRequest and AQResponse objects and an AQMail enhancement to specify the reply-to email header.

Following are the enhancements to the Open APIs in v10.0:

• AQVersionControl
  • public AQPerforce newPerforce() - Returns an unconnected Perforce object
  • public AQGit newGit() - Returns an unconnected GIT object
• AQPerforce
  • void connect(String url, String client, String folder, Object username, Object password) - Establishes connection to the perforce server
  • void add(Object files) - Open one or more Perforce client workspace files for adding to the Perforce server
  • void edit(Object files) - Open one or more Perforce client workspace files for editing
  • void revert(Object files) - Revert an open Perforce client workspace file back to the revision previously synced from the Perforce depot
  • void sync(Object files) - This method syncs the local filesystem with the latest Perforce revision
  • void submit(Object files,String comment) - This method commits submits changes in the specified file or folder into the Perforce revision control system
  • AQRevision getRevision(String filename) - Returns the file revision
  • AQRevision[] getHistory(String filename) - Returns the file's complete revision history
  • AQRevision[] getHistory(String filename, int count) - Returns the file's revision history
  • byte[] getRevisionContents(String filename, String revision) - Returns the binary contents of the specified revision
  • void setVerbose(boolean verbose) - Sets the amount of diagnostic messages sent to the debugger console
  • void close() - Disconnects the object from Perforce server
• AQGit
  • void init(String folder,boolean bare) - Creates an empty git repository or reinitialize an existing one
  • void setWorkspace(String path) - Sets workspace folder
  • void clone(String folder, String url, String branch) - Clones a repository into a new directory
  • void add(Object files) - Adds one or more files to the list of files staged for the next commit
  • void fetch() - Downloads objects and refs from one or more other repositories
  • void merge(String ref) - Performs a very basic merge operation, which allows only one argument
  • void pull() - Incorporates changes from a remote repository into the current branch
  • void commit(Object files, Object username, Object email, String comment)  - This method commits changes in the specified file or folder
  • void sync(Object files) - This method syncs the local filesystem with the latest Perforce revision
  • AQRevision getRevision(String filename) - Returns the file revision
  • AQRevision[] getHistory(String filename) - Returns the file's complete revision history
  • AQRevision[] getHistory(String filename, int count) - Returns the file's revision history
  • byte[] getRevisionContents(String filename, String revision) - Returns the binary contents of the specified revision
  • void setVerbose(boolean verbose) - Sets the amount of diagnostic messages sent to the debugger console
• AQCompareOptions
  • void setTrimLeft(boolean enable) - If true, trims the whitespace on the left side of each line before comparison
  • boolean isTrimLeft() - Returns trim-left option value
  • void setTrimRight(boolean enable) - If true, trims the whitespace on the right side of each line before comparison
  • boolean isTrimRight() - Returns trim-right option value
  • void setTrimMiddle(boolean enable) - If true, reduces any number of whitespace symbols within each line to a single space character before comparison
  • boolean isTrimMiddle() - Returns trim-middle option value
  • void setIgnoreCase(boolean enable) - If true, the comparison will ignore the case
  • boolean isIgnoreCase() - Returns true if the comparison operation will ignore case
  • void setIgnoreBlankLines(boolean enable) - If true, the comparison will ignore blank lines
  • boolean isIgnoreBlankLines() - Returns true if the comparison operation will ignore blank lines
  • void setIgnoreWhitespace(boolean enable) - If true, the comparison will ignore whitespace
• AQDataFactory
  • public AQExcelSpreadsheet excelSpreadsheet(String filename) - This factory method returns a new in-memory Excel spreadsheet
• AQSchemaComparator
  • public AQCompareOptions getCompareOptions() - Returns a mutable object which allows for setting comparison options
• AQSchemaDifferences
  • public AQCompareOptions getCompareOptions() - Returns a mutable object which allows for setting comparison options
• AQDataFactory
  • public AQExcelSpreadsheet excelSpreadsheet(String filename) - This factory method returns a new in-memory Excel spreadsheet
• AQExcelSpreadsheet
  • void setCell(int row, int column, Object value) - Sets the cell value at the specified row and column in the current worksheet
  • void setCell(Object value) - Sets the cell value at the current row and column in the current worksheet
  • void setCurrentWorksheet(String name) - Sets the current worksheet
  • String getCurrentWorksheet() - Returns the current worksheet name
  • void setRow(int row) - Sets the current row (0-based)
  • int getRow() - Returns the current column (0-based)
  • void nextRow() - Advances current row by one
  • void setColumn(int column) - Sets the current column (0-based)
  • int getColumn() - Returns the current column (0-based)
  • void insertPivotTable(AQPivotDataSet pivotDataSet) - Creates a new worksheet with the pivot data set inserted
  • void insert(AQDataSet dataSet, boolean firstLineContainsColumnNames) - Inserts the data set into the current worksheet, starting with the current row and column
  • void insert(AQDataReader reader, boolean firstLineContainsColumnNames) - Inserts the row of values into the current worksheet, starting with the current row and column 
  • void insert(AQDataRow dataRow) - Inserts the data read from the specified reader into the current worksheet, starting with the current row and column
  • void clear() - Clears the spreadsheet
  • void setAutoResize(boolean enable) - When enabled, the cell widths will be resized to fit the contents on the next save() operation
  • void save() - Saves the spreadsheet
  • void save(String filename) - Saves the spreadsheet to a new file
• AQReport
  • public void saveAsExcel2007(String fileName) - saves report in Excel 2007 format
  • public byte[] getAsExcel2007() - returns report as a byte array in Excel 2007 format
  • public void saveTo(AQExcelSpreadsheet spreadsheet) - Inserts report in an Excel spreadsheet
• AQPivotDataSet
  • public void saveAsExcel2007(String fileName) - saves pivot data in Excel 2007 format
  • public void saveAsExcel2007(String fileName, AQDataSetSettings settings, AQChart chart) - save pivot data and chart in Excel 2007 format
  • public byte[] getAsExcel2007() - returns pivot data as a byte array in Excel 2007 format
  • public byte[] getAsExcel2007(AQDataSetSettings settings, AQChart chart) - returns pivot data and chart as a byte array in Excel 2007 format
• AQDataSet
  • public void saveAsExcel2007(String filename) - saves data set in Excel 2007 format
  • public void saveAsExcel2007(String fileName, AQDataSetSettings settings, AQChart chart) - saves data set  and chart in Excel 2007 format
  • public byte[] getAsExcel2007() - returns data set as a byte array in Excel 2007 format
  • public byte[] getAsExcel2007(AQDataSetSettings settings, AQChart chart) - returns data set and chart as a byte array in Excel 2007 format
• AQStatementResults
  • public AQDataSet[] getResultData() - Returns an array of {@link AQDataSet} objects containing query results
• AQServerConnection
  • public void connect(Object password) - establishes SQL connection to the server with the provided password
  • public void connect(Object username, Object password) - establishes SQL connection to the server with the provided user credentials
• AQInputOutputFactory
  • public AQExcelWriter newExcel2007Writer() - creates new Excel 2007 file writer
• AQTextFileWriter
  • void setAppendMode(boolean enable) – Appends data with writers
• AQResponse
  • public void setTitle(String title) - sets the TITLE tag for HTML responses
  • public String getTitle() - returns the value fo the the TITLE tag
  • public void addMetaTag(String name, String value) - sets the META tag for HTML responses
  • public void clearMetaTags() - removes previously set meta tags
• AQRequest
  • public String getRemoteAddr() - returns the Internet Protocol (IP) address of the client or last proxy that sent the request
  • public String getRemoteHost() - returns the fully qualified name of the client or the last proxy that sent the request
• AQSystem
  • public String getProperty(String key) - retrieves the java system property indicated by the specified key
  • public String getProperty(String key, String def) - retrieves the java system property indicated by the specified key. If key is not found, def is returned
  • public String getenv(String name) - retrieves the value of the specified environment variable
• AQMailMessage
  • public void addReplyTo(String replyTo) - specifies the reply-to list of email addresses
  • public String[] getReplyTo() - retrieves the list of reply-to email addresses
• AQRandomFactory
  • public String nextCreditCardCVC(String cardNumber) - Returns a random 3- or 4-digit credit card verification number, depending on the type of card determined from the card number argument

 Charts

• AQChartProperties
  • void setChartTypeCloud() - set the chart type for all series to Cloud
  • void setChartTypeCloud(int seriesNumber) - set the chart type for the specified series to Cloud
  • void setChartTypeLine3d() - set the chart type for all series to Line
  • void setChartTypeLine3d(int seriesNumber) - set the chart type for the specified series to 3D Line
  • public void moveSeries(int fromSeriesIndex, int toSeriesIndex) - moves the series at position "fromSeriesIndex" to position "toSeriesIndex" float setOpacity - set the opacity to render chart geometry
  • float getOpacity - get the opacity used to render chart geometry
  • setGridLineWidth(float lineWidth) - set the width of the grid lines
  • float getGridLineWidth() - return the width of the grid lines
  • void setFillGrid(boolean fillGrid) - set to True to fill the grid, False to only show the grid lines
  • boolean isFillGrid() - return True if the grid is filled, False if only the grid lines are shown
  • void setShowValueAxisTicks(boolean showValueAxisTicks) - set to True if the value axis tick marks are displayed 
  • boolean isShowValueAxisTicks() - return True if the value axis tick marks are displayed
  • void setShowCategoryAxisTicks(boolean showCategoryAxisTicks) - set to True if the category axis tick marks are displayed
  • boolean isShowCategoryAxisLines() - return True if the Category axis lines are displayed
  • void setTitlePosition(String titlePosition) - set the Title position ("Top Left", "Top Center", "Top Right", "Left Center", "Right Center", "Bottom Left", "Bottom Center", "Bottom Right")
  • void setTitlePositionBottomCenter() - set the Chart Title Position Bottom Center
  • void setTitlePositionBottomRight() - set the Chart Title Position Bottom Right
  • void setTitlePositionTopCenter() - set the Chart Title Position Top Center
  • void setTitlePositionTopLeft() - set the Chart Title Position Top Left
  • void setTitlePositionTopRight() - set the Chart Title Position Top Right
  • void setLegendPosition(String position) - set the Legend position ("Top Left", "Top Right", "Bottom Left", "Bottom Right")
  • void setLegendPositionBottomCenter() - place the Legend in the Bottom Center of the rendering area
  • void setLegendPositionBottomLeft() - place the Legend in the Bottom Left corner of the rendering area
  • void setLegendPositionBottomRight() - place the Legend in the Bottom Right corner of the rendering area
  • void setLegendPositionLeftCenter() - place the Legend in the Left Center of the rendering area
  • void setLegendPositionRightCenter() - place the Legend in the Right Center of the rendering area
  • void setLegendPositionTopCenter() - place the Legend in the Top Center of the rendering area
  • void setLegendPositionTopLeft() -  place the Legend in the Top Left corner of the rendering area
  • void setLegendPositionTopRight() - place the Legend in the Top Right corner of the rendering area
  • void setShowValueAxisLines(boolean showValueAxisLines) - set to True if the value axis lines are displayed
  • boolean isShowValueAxisLines() - return True if the value axis lines are displayed
  • void setShowCategoryAxisLines(boolean showCategoryAxisLines) - set to True if the Category axis lines are displayed
  • boolean isShowCategoryAxisLines() - return True if the Category axis lines are displayed
  • void addFunctionSeries(String functionString) - Perform series functions on a specified ranges of values
  • boolean isShowDataLabels() - return True if labels should be displayed at each data point
  • void setShowDataLabels(boolean showDataLabels)  - set to True if labels should be displayed at each data point
  • boolean isShowDataLabels(int seriesNumber) - return True if labels should be displayed at each data point
  • void setShowDataLabels(int seriesNumber, boolean showDataLabels) - set to True if labels should be displayed at each data point

• This below methd was renamed in AQComparator for v 10.0
  • public AQDifferences compareText(String a, String b)) - This method compares two text strings line-by-line, based on configured settings