org.sistema.cs.doc.persist

Class DocUtilities

java.lang.Object

org.sistema.cs.doc.persist.DocUtilities

public class DocUtilities
extends java.lang.Object

Helper functions for IDoc and related classes.

Code that processes objects (like calculating an invoice amount) is concentrated in this class (instead of in the persistent object classes) to make the persistent objects class reducing network bandwidth and increasing code security (by avoiding code traveling with the persistent object).

Some functions require a persistent manager and must be provided before calling them.

Since:

29-nov-2005 11:09

Version:

2.1 08-nov-2020 Juan Díaz (Yancuicalco, Tepoztlán)

Author:

Juan Díaz

Field Summary

Fields

Modifier and Type	Field and Description
private static org.sistema.persist.PersistentService	persistentManager The manager required to perform queries of persistent objects.

Constructor Summary

Constructors

Constructor and Description
DocUtilities()

Method Summary

Modifier and Type	Method and Description
static int	compare(IDoc doc, java.time.ZonedDateTime date) Compares the date of a document to a zoned time.
static int	count(java.util.Collection<IDoc> docs, IDocType type) Counts the number of documents of a given type.
static java.util.Collection<IItemPerc>	getDefaultPercentages(java.util.Date date, java.lang.String ticket)
static java.lang.Iterable<IItem>	getItems(IDocItemized document) Builds an array with every IItem on the invoice.
static java.util.Collection	getPayments(IDoc document, java.util.Date closingDate) Retrieves the payments
static java.math.BigDecimal	getPercentageAmount(IItem item, java.math.BigDecimal baseAmount, java.math.BigDecimal runningSum, java.lang.Integer percentageId)
static java.lang.Iterable<IItemPerc>	getPercentages(IDocValued doc, int typeId)
static java.util.Collection	getPercentageTypes(IDocItemized document) Builds a collection with the percentage types that are set on an invoice.
static java.math.BigDecimal	getSubtotal(IDocItemized document) Calculates the subtotal of an invoice based an all it's items value.
static java.lang.Boolean	isDocumentCancelled(IDoc document) Standard way to determine if a document has been cancelled.
private static boolean	isToBeAdded(java.util.Collection<IDoc> docs, java.util.Collection<IDocType> filter, IDoc doc) Determines whether a given document should be added to a collection of documents or not.
static IItemPerc	loadPercentage(byte typeId, int order) Loads a percentage instance from the persistent service.
static IPercType	loadPercentageType(byte typeId) Loads a percentage type from the persistent service.
static IItemPerc	readPercentage(IDocItem di, byte typeId) Retrieves a percentage of a given type from the item of a IDocItem relationship.
static IItemPerc	readPercentage(IItem i, byte typeId, int order) Retrieves the percentage of a given type from an item.
static java.util.Collection<IDoc>	readRelatedDocuments(java.util.Collection<IDoc> documents, java.util.Collection filter) Builds a collection with documents related to some documents.
static java.util.Collection<IDoc>	readRelatedDocuments(IDocItemized doc, java.util.Collection<IDocType> typeFilter)
static java.util.Collection<IDoc>	readRelatedDocuments(java.lang.Integer docId, java.util.Collection<IDocItem> docItems, java.util.Collection<IDocType> typeFilter) Reads all documents related to each child present in a collection of IDocItem relationships.
static void	setPersistentManager(org.sistema.persist.PersistentService newManager) Sets the persistent manager used by functions of this class to perform queries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

persistentManager

private static org.sistema.persist.PersistentService persistentManager

The manager required to perform queries of persistent objects.

Constructor Detail

DocUtilities

public DocUtilities()

Method Detail

compare

public static int compare(IDoc doc,
                          java.time.ZonedDateTime date)

Compares the date of a document to a zoned time.

Parameters:

doc -

date -

Returns:

the result of comparing date with doc.getDate() or doc.getTime().

Since:

v2.0

count

public static int count(java.util.Collection<IDoc> docs,
                        IDocType type)

Counts the number of documents of a given type.

Parameters:

docs -

type -

Returns:

Since:

v2.0

getItems

public static java.lang.Iterable<IItem> getItems(IDocItemized document)

Builds an array with every IItem on the invoice.

Parameters:

document -

Returns:

Since:

04-nov-2011

getPayments

public static java.util.Collection getPayments(IDoc document,
                                               java.util.Date closingDate)

Retrieves the payments

Parameters:

document - Document to retrieve the payments from

closingDate -

Returns:

Since:

v1.3 02-may-2011

getPercentageAmount

public static java.math.BigDecimal getPercentageAmount(IItem item,
                                                       java.math.BigDecimal baseAmount,
                                                       java.math.BigDecimal runningSum,
                                                       java.lang.Integer percentageId)

Parameters:

item -

baseAmount -

runningSum -

percentageId -

Returns:

getPercentageTypes

public static java.util.Collection getPercentageTypes(IDocItemized document)

Builds a collection with the percentage types that are set on an invoice.

Parameters:

document -

Returns:

A collection with the percentages types present on the items of a document, if any. If the document contains no items or the items don't contain any percentages, an empty collection is returned.

getPercentages

public static java.lang.Iterable<IItemPerc> getPercentages(IDocValued doc,
                                                           int typeId)

Parameters:

doc -

typeId -

Returns:

A collection with those percentages with an id equal to typeId or an empty collection when no percentages match.

getSubtotal

public static java.math.BigDecimal getSubtotal(IDocItemized document)

Calculates the subtotal of an invoice based an all it's items value.

Parameters:

document -

Returns:

getDefaultPercentages

public static java.util.Collection<IItemPerc> getDefaultPercentages(java.util.Date date,
                                                                    java.lang.String ticket)
                                                             throws java.lang.Exception

Returns:

An array of ItemPercentages with it's attributes set to the default values on the specified date.

Throws:

java.lang.Exception

isDocumentCancelled

public static java.lang.Boolean isDocumentCancelled(IDoc document)

Standard way to determine if a document has been cancelled. *

A document is cancelled when the ATTRIBUTE_STAUS_CANCELLED has been set.

Using this method (instead of checking the ATTRIBUTE_STATUS field of a document object) makes maintenance easier (just one place to change the logic when required).

Parameters:

document -

Returns:

Since:

30-jun-2009 20:27

See Also:

DocumentConstants

isToBeAdded

private static boolean isToBeAdded(java.util.Collection<IDoc> docs,
                                   java.util.Collection<IDocType> filter,
                                   IDoc doc)

Determines whether a given document should be added to a collection of documents or not.

Temporal method until Persistent.equals() is fixed (avoiding the infinite loop that occurs).

Parameters:

docs -

doc -

filter -

Returns:

true only when the type of the document is set in the filter collection, and the document has not been added to the collection.

Since:

v2.0

loadPercentage

public static IItemPerc loadPercentage(byte typeId,
                                       int order)
                                throws java.lang.Exception

Loads a percentage instance from the persistent service.

Parameters:

typeId -

Returns:

A new percentage instance of type typeId.

Throws:

java.lang.Exception

loadPercentageType

public static IPercType loadPercentageType(byte typeId)
                                    throws java.lang.Exception

Loads a percentage type from the persistent service.

Parameters:

typeId -

Returns:

Throws:

java.lang.Exception

readPercentage

public static IItemPerc readPercentage(IDocItem di,
                                       byte typeId)
                                throws java.lang.Exception

Retrieves a percentage of a given type from the item of a IDocItem relationship.

It if does not exist, a new is loaded from the persistent service.

Parameters:

di -

typeId -

Returns:

Throws:

java.lang.Exception

Since:

v2.0

readPercentage

public static IItemPerc readPercentage(IItem i,
                                       byte typeId,
                                       int order)
                                throws java.lang.Exception

Retrieves the percentage of a given type from an item.

It i does not contain a percentage of type typeId a IItemPerce instance is loaded from the persistent service and added to the i.

Parameters:

i - item from which the percentage is being requested

typeId - identifier of the percentage type being requested

order - order of the percentage being requested

Returns:

Throws:

java.lang.Exception

Since:

v2.0

readRelatedDocuments

public static java.util.Collection<IDoc> readRelatedDocuments(IDocItemized doc,
                                                              java.util.Collection<IDocType> typeFilter)

Parameters:

doc -

typeFilter - document types to select, types not included are excluded

Returns:

readRelatedDocuments

public static java.util.Collection<IDoc> readRelatedDocuments(java.lang.Integer docId,
                                                              java.util.Collection<IDocItem> docItems,
                                                              java.util.Collection<IDocType> typeFilter)

Reads all documents related to each child present in a collection of IDocItem relationships.

The related documents of each item are defined as the union of:

1. documents directly related to the item (obtained by calling IItem.getRelatedDocs()),
2. documents indirectly related to each related item (obtained by calling IItem.getRelatedDocs() on each element of IItem.getRelatedItems().
3. documents related to each resulting document from steps 1 and 2.

Parameters:

docId - identifier of the document for which related documents are being requested.

docItems - document-item relations of the document.

typeFilter - document types to select, types not included are excluded

Returns:

Collection of documents related to the document. When no documents are related, an empty collection is returned.

Since:

v2.0

readRelatedDocuments

public static java.util.Collection<IDoc> readRelatedDocuments(java.util.Collection<IDoc> documents,
                                                              java.util.Collection filter)

Builds a collection with documents related to some documents.

Parameters:

documents - Documents for which related documents are being requested.

filter - Relationship types to be included. Relationship types not included are filtered out.

Returns:

Collection of documents related to the document. When no documents are related, an empty collection is returned.

Since:

v2.0

setPersistentManager

public static void setPersistentManager(org.sistema.persist.PersistentService newManager)

Sets the persistent manager used by functions of this class to perform queries.

Parameters:

newManager - The persistent manager.

Since:

28-aug-2010