Method Detail

• public EntityDataWriter allEntities()

  Add all entities to entity names. For backward compatibility (before the skip entity names feature), if any entity names were specified before calling this they are excluded from all entities instead of included.

• public EntityDataWriter dependentLevels(int levels)

  The number of levels of dependents to include for records written. If set dependentRecords will be considered true. If dependentRecords is set but no level limit is specified all levels found will be written (may be large and not what is desired).

• public EntityDataWriter dependentRecords(boolean dependents)

  Should the dependent records of each record be written? If set will include 2 levels of dependents by default, use dependentLevels() to specify a different number of levels.

  Parameters:

  dependents - Boolean dependents indicator

  Returns:

  Reference to this for convenience.

• public int directory(java.lang.String path)

  Write the results to a file for each entity in the specified directory.

  Parameters:

  path - The path of the directory to create files in

  Returns:

  Count of values written

• public EntityDataWriter entityName(java.lang.String entityName)

  Specify the name of an entity to query and export. Data is queried and exporting from entities in the order they are added by calling this or entityNames() multiple times.

  Parameters:

  entityName - The entity name

  Returns:

  Reference to this for convenience.

• public EntityDataWriter entityNames(java.util.Collection<java.lang.String> entityNames)

  A List of entity names to query and export. Data is queried and exporting from entities in the order they are specified in this list and other calls to this or entityName().

  Parameters:

  entityNames - The list of entity names

  Returns:

  Reference to this for convenience.

• public int file(java.lang.String filename)

  Write all results to a single file.

  Parameters:

  filename - The path and name of the file to write values to

  Returns:

  Count of values written

• public EntityDataWriter fileType(EntityDataWriter.FileType ft)

• public EntityDataWriter fileType(java.lang.String ft)

• public EntityDataWriter filterMap(java.util.Map<java.lang.String, java.lang.Object> filterMap)

  A Map of field name, value pairs to filter the results by. Each name/value only used on entities that have a field matching the name.

  Parameters:

  filterMap - Map with name/value pairs to filter by

  Returns:

  Reference to this for convenience.

• public EntityDataWriter fromDate(java.sql.Timestamp fromDate)

  From date for lastUpdatedStamp on each entity (lastUpdatedStamp must be greater than or equal (>=) to fromDate).

  Parameters:

  fromDate - The from date

  Returns:

  Reference to this for convenience.

• public EntityDataWriter isoDateTime(boolean iso)

  Write Date, Time, and Timestamp fields in ISO format instead of millis since epoch integer; currently only supported for CSV

• public EntityDataWriter master(java.lang.String masterName)

  The name of a master definition, applied to all written entities that have a matching master definition otherwise just the single record is written, or dependent records if dependentREcords or dependentLevels options specified.

• public EntityDataWriter orderBy(java.util.List<java.lang.String> orderByList)

  Field names to order (sort) the results by. Each name only used on entities with a field matching the name. May be called multiple times. Each entry may be a comma-separated list of field names.

  Parameters:

  orderByList - List with field names to order by

  Returns:

  Reference to this for convenience.

• public EntityDataWriter skipEntityName(java.lang.String entityName)

• public EntityDataWriter skipEntityNames(java.util.Collection<java.lang.String> enList)

• public EntityDataWriter tableColumnNames(boolean tcn)

  Write table and column names instead of entity and field names; currently only supported for CSV

• public EntityDataWriter thruDate(java.sql.Timestamp thruDate)

  Thru date for lastUpdatedStamp on each entity (lastUpdatedStamp must be less than (<) to thruDate).

  Parameters:

  thruDate - The thru date

  Returns:

  Reference to this for convenience.

• public int writer(java.io.Writer writer)

  Write the results to a Writer.

  Parameters:

  writer - The Writer to write to

  Returns:

  Count of values written

• public int zipDirectory(java.lang.String pathWithinZip, java.lang.String zipFilename)

  Write to a directory in a zip file located at zipFilename

• public int zipDirectory(java.lang.String pathWithinZip, java.io.OutputStream outputStream)

  Write to a directory in a zip file in an OutputStream; NOTE: closes OutputStream when done

• public int zipFile(java.lang.String filenameWithinZip, java.lang.String zipFilename)