Field Detail

• public EntityDataWriter.FileType JSON

• public EntityDataWriter.FileType XML

Method Detail

• public EntityDataWriter allEntities()

  Write data from all entities. When set other entity names are excluded 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.

  Returns:

  Reference to this for convenience.

  Parameters:

  dependents - Boolean dependents indicator

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

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

  Returns:

  Count of values written

  Parameters:

  path - The path of the directory to create files in

• 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.

  Returns:

  Reference to this for convenience.

  Parameters:

  entityName - The entity name

• public EntityDataWriter entityNames(java.util.List<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().

  Returns:

  Reference to this for convenience.

  Parameters:

  entityNames - The list of entity names

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

  Write all results to a single file.

  Returns:

  Count of values written

  Parameters:

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

• public EntityDataWriter fileType(EntityDataWriter.FileType ft)

  Used to write XML entity data from the database to a writer. The document will have a root element like <entity-facade-xml>.

• 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.

  Returns:

  Reference to this for convenience.

  Parameters:

  filterMap - Map with name/value pairs to filter by

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

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

  Returns:

  Reference to this for convenience.

  Parameters:

  fromDate - The from date

• 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.

  Returns:

  Reference to this for convenience.

  Parameters:

  orderByList - List with field names to order by

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

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

  Returns:

  Reference to this for convenience.

  Parameters:

  thruDate - The thru date

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

  Write the results to a Writer.

  Returns:

  Count of values written

  Parameters:

  writer - The Writer to write to

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

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