|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.cayenne.access.ObjectStore
public class ObjectStore
ObjectStore stores objects using their ObjectId as a key. It works as a dedicated object cache for a DataContext. Users rarely need to access ObjectStore directly, as DataContext serves as a facade, providing cover methods for most ObjectStore operations.
| Field Summary | |
|---|---|
protected java.util.Map |
changes
|
protected DataContext |
context
The DataContext that owns this ObjectStore. |
protected DataRowStore |
dataRowCache
Stores a reference to the DataRowStore. |
protected java.util.Map |
newObjectsMap
|
protected java.util.Map |
objectMap
|
protected java.util.Map |
queryResultMap
|
| Constructor Summary | |
|---|---|
ObjectStore()
|
|
ObjectStore(DataRowStore dataRowCache)
|
| Method Summary | |
|---|---|
void |
addObject(DataObject object)
Deprecated. since 1.2 as a different change tracking algorithm is used. |
void |
arcCreated(java.lang.Object nodeId,
java.lang.Object targetNodeId,
java.lang.Object arcId)
Does nothing. |
void |
arcDeleted(java.lang.Object nodeId,
java.lang.Object targetNodeId,
java.lang.Object arcId)
Does nothing. |
int |
cachedQueriesCount()
Returns a number of query results cached by this object store. |
void |
cacheQueryResult(java.lang.String name,
java.util.List results)
Caches a list of query results. |
java.util.List |
getCachedQueryResult(java.lang.String name)
Returns cached query results for a given query, or null if no results are cached. |
DataRow |
getCachedSnapshot(ObjectId oid)
Returns a snapshot for ObjectId from the underlying snapshot cache. |
DataContext |
getContext()
|
DataRowStore |
getDataRowCache()
Returns a DataRowStore associated with this ObjectStore. |
java.lang.Object |
getNode(java.lang.Object nodeId)
Returns a registered DataObject or null of no object exists for the ObjectId. |
DataObject |
getObject(ObjectId id)
Deprecated. since 1.2 a GraphManager getNode(Object) method should be
used. |
java.util.Iterator |
getObjectIterator()
Returns an iterator over the registered objects. |
java.util.List |
getObjects()
Deprecated. since 1.2 use GraphManager method registeredNodes() . |
DataRow |
getSnapshot(ObjectId oid)
Returns a snapshot for ObjectId from the underlying snapshot cache. |
DataRow |
getSnapshot(ObjectId oid,
QueryEngine engine)
Deprecated. since 1.2. Use getSnapshot(ObjectId) instead. |
void |
graphCommitAborted()
Does nothing. |
void |
graphCommitStarted()
Does nothing. |
void |
graphCommitted()
Does nothing. |
void |
graphRolledback()
Does nothing. |
boolean |
hasChanges()
Returns true if there are any modified, deleted or new objects
registered with this ObjectStore, false otherwise. |
void |
nodeCreated(java.lang.Object nodeId)
Does nothing. |
void |
nodeIdChanged(java.lang.Object nodeId,
java.lang.Object newId)
Does nothing. |
void |
nodePropertyChanged(java.lang.Object nodeId,
java.lang.String property,
java.lang.Object oldValue,
java.lang.Object newValue)
Does nothing. |
void |
nodeRemoved(java.lang.Object nodeId)
Does nothing. |
void |
objectRelationshipSet(DataObject source,
DataObject target,
ObjRelationship relationship,
boolean processFlattened)
Deprecated. since 1.2 use recordArcCreated(Persistent, ObjectId, String) . |
void |
objectRelationshipUnset(DataObject source,
DataObject target,
ObjRelationship relationship,
boolean processFlattened)
Deprecated. since 1.2 use recordArcDeleted(Persistent, ObjectId, String) . |
void |
objectsCommitted()
Deprecated. since 1.2 unused. |
java.util.List |
objectsInState(int state)
Return a subset of registered objects that are in a certian persistence state. |
void |
objectsInvalidated(java.util.Collection objects)
Invalidates a collection of DataObjects. |
void |
objectsRolledBack()
Reverts changes to all stored uncomitted objects. |
void |
objectsUnregistered(java.util.Collection objects)
Evicts a collection of DataObjects from the ObjectStore, invalidates the underlying cache snapshots. |
void |
recordArcCreated(Persistent object,
ObjectId targetId,
java.lang.String relationshipName)
Performs tracking of object relationship changes. |
void |
recordArcDeleted(Persistent object,
ObjectId targetId,
java.lang.String relationshipName)
Performs tracking of object relationship changes. |
java.util.Collection |
registeredNodes()
Returns all registered DataObjects. |
int |
registeredObjectsCount()
Returns a number of objects currently registered with this ObjectStore. |
void |
registerNode(java.lang.Object nodeId,
java.lang.Object nodeObject)
"Registers" a graph node, usually striong the node in some internal map using its id as a key. |
void |
resolveHollow(DataObject object)
Initializes object with data from cache or from the database, if this object is not fully resolved. |
void |
setContext(DataContext context)
|
void |
setDataRowCache(DataRowStore dataRowCache)
Sets parent DataRowStore. |
void |
snapshotsChanged(SnapshotEvent event)
SnapshotEventListener implementation that processes snapshot change event, updating DataObjects that have the changes. |
void |
snapshotsUpdatedForObjects(java.util.List objects,
java.util.List snapshots,
boolean refresh)
Updates snapshots in the underlying DataRowStore. |
void |
startTrackingNewObjects()
Starts tracking the registration of new objects from this ObjectStore. |
void |
unregisterNewObjects()
Unregisters the newly registered DataObjects from this objectStore. |
java.lang.Object |
unregisterNode(java.lang.Object nodeId)
"Unregisters" a graph node, forgetting any information associated with nodeId. |
void |
validateUncommittedObjects()
Deprecated. since 1.2 - This method is no longer used in Cayenne internally. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected transient java.util.Map newObjectsMap
protected java.util.Map objectMap
protected java.util.Map queryResultMap
protected java.util.Map changes
protected transient DataRowStore dataRowCache
Serialization note: It is up to the owner of this ObjectStore to initialize DataRowStore after deserialization of this object. ObjectStore will not know how to restore the DataRowStore by itself.
protected DataContext context
| Constructor Detail |
|---|
public ObjectStore()
public ObjectStore(DataRowStore dataRowCache)
| Method Detail |
|---|
public void recordArcCreated(Persistent object, ObjectId targetId, java.lang.String relationshipName)
public void recordArcDeleted(Persistent object, ObjectId targetId, java.lang.String relationshipName)
public int registeredObjectsCount()
public int cachedQueriesCount()
public DataRowStore getDataRowCache()
public void setDataRowCache(DataRowStore dataRowCache)
public void objectsInvalidated(java.util.Collection objects)
objectsUnregistered(Collection)
public void objectsUnregistered(java.util.Collection objects)
objectsInvalidated(Collection)
public void objectsRolledBack()
public void objectRelationshipUnset(DataObject source, DataObject target, ObjRelationship relationship, boolean processFlattened)
recordArcDeleted(Persistent, ObjectId, String)
.
public void objectRelationshipSet(DataObject source, DataObject target, ObjRelationship relationship, boolean processFlattened)
recordArcCreated(Persistent, ObjectId, String)
.
public void snapshotsUpdatedForObjects(java.util.List objects, java.util.List snapshots, boolean refresh)
refresh
is
true, all snapshots in snapshots
will be loaded into DataRowStore,
regardless of the existing cache state. If refresh
is false, only
missing snapshots are loaded. This method is normally called internally by the
DataContext owning the ObjectStore to update the caches after a select query.
objects
- a list of object whose snapshots need to be updated.snapshots
- a list of snapshots. Must be of the same length and use the same
order as objects
list.refresh
- controls whether existing cached snapshots should be replaced with
the new ones.public void objectsCommitted()
public void addObject(DataObject object)
public void startTrackingNewObjects()
unregisterNewObjects()
public void unregisterNewObjects()
startTrackingNewObjects()
public DataObject getObject(ObjectId id)
getNode(Object)
method should be
used.
public DataRow getCachedSnapshot(ObjectId oid)
public java.util.List getCachedQueryResult(java.lang.String name)
public void cacheQueryResult(java.lang.String name, java.util.List results)
public DataRow getSnapshot(ObjectId oid, QueryEngine engine)
getSnapshot(ObjectId)
instead.
public DataRow getSnapshot(ObjectId oid)
public java.util.List getObjects()
registeredNodes()
.
public java.util.Iterator getObjectIterator()
public boolean hasChanges()
true
if there are any modified, deleted or new objects
registered with this ObjectStore, false
otherwise. This method will
treat "phantom" modifications are real ones. I.e. if you "change" an object
property to an equivalent value, this method will still think such object is
modified. Phantom modifications are only detected and discarded during commit.
public java.util.List objectsInState(int state)
public void snapshotsChanged(SnapshotEvent event)
Implementation note: This method should not attempt to alter the underlying DataRowStore, since it is normally invoked *AFTER* the DataRowStore was modified as a result of some external interaction.
snapshotsChanged
in interface SnapshotEventListener
public void validateUncommittedObjects() throws ValidationException
ValidationException
public void resolveHollow(DataObject object)
public DataContext getContext()
public void setContext(DataContext context)
public java.lang.Object getNode(java.lang.Object nodeId)
getNode
in interface GraphManager
public java.util.Collection registeredNodes()
registeredNodes
in interface GraphManager
public void registerNode(java.lang.Object nodeId, java.lang.Object nodeObject)
GraphManager
registerNode
in interface GraphManager
public java.lang.Object unregisterNode(java.lang.Object nodeId)
GraphManager
unregisterNode
in interface GraphManager
public void graphCommitAborted()
public void graphCommitStarted()
public void graphCommitted()
public void graphRolledback()
public void nodeIdChanged(java.lang.Object nodeId, java.lang.Object newId)
nodeIdChanged
in interface GraphChangeHandler
public void nodeCreated(java.lang.Object nodeId)
nodeCreated
in interface GraphChangeHandler
public void nodeRemoved(java.lang.Object nodeId)
nodeRemoved
in interface GraphChangeHandler
public void nodePropertyChanged(java.lang.Object nodeId, java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue)
nodePropertyChanged
in interface GraphChangeHandler
public void arcCreated(java.lang.Object nodeId, java.lang.Object targetNodeId, java.lang.Object arcId)
arcCreated
in interface GraphChangeHandler
public void arcDeleted(java.lang.Object nodeId, java.lang.Object targetNodeId, java.lang.Object arcId)
arcDeleted
in interface GraphChangeHandler
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |


ExecutorService
that delegates to an existing Executor
but constrains the number of concurrently executing tasks to a pre-configured value.ConstrainedExecutorService
.ConstrainedExecutorService.execute(Runnable)
to
ensure that view of memory is consistent between different threads executing tasks serially.FrameSequenceView
ConstrainedExecutorService
with an unbounded
LinkedBlockingQueue
queue.FrameSequenceView
FrameSequenceView
is no longer needed in order to release resources and avoid memory leak.FrameSequenceSource
object to display by FrameSequenceView
.


The Tesla home battery has been getting a...
2 min read
The Tesla home battery has been getting a lot of attention. Will it resolve the intermittentcy problem for solar? Probably not. Its too expensive.
http:/
This is very interesting because, at present, battery grid storage is not generally economical. The problem is the cost of the batteries. While batteries can be as much as 90% efficient, they wear out the more you use and recharge them. Batteries vary a lot in how many cycles they will deliver, and this varies according to how you use the battery (ie. do you drain it all the way, or use only the middle of the range, etc.) If your battery will deliver 1,000 cycles using 60% of its range (from 20% to 80%) and costs $400/kwh, then you will get 600kwh over the lifetime of a kwh unit, or 66 cents per kwh (presuming no residual value.) That’s not an economical cost for energy anywhere, except perhaps off-grid. (You also lose a cent or two from losses in the system.) If you can get down to 9 cents/kwh, plus 1 cent for losses, you get parity with the typical grid. However, this is modified by some important caveats:
If you have a grid with very different prices during the day, you can charge your batteries at the night price and use them during the daytime peak. You might pay 7 cents at night and avoid 21 cent prices in the day, so a battery cost of 14 cents/kwh is break-even.
You get a backup power system for times when the grid is off.  For many it’s worth several hundred dollars. (But not too many as you can get a generator as backup and most people don’t.)
Because battery prices are dropping fast, a battery pack today will lose value quickly, even before it physically degrades. And yes, in spite of what you might imagine in terms of “who cares, as long as it’s working,” that matters.


DocWave A Browser for Javascript API Documentation
DocWave is a developer documentation tool to easily browse through JavaScript APIs. The application currently comes with Node, Express, and Mozilla's documentation for HTML, CSS, and JavaScript. If you would like try it out, the download links are below. If you would like to contribute or raise issues, our github page can be found here.


Mkhari ‘Respects’ Ramaphosa’s Decision To Withdraw From Chairman’s Conversation
by NG EditorJOHANNESBURG – PowerFM chairman Given Mkhari on Thursday said he respected the decision by President Cyril Ramaphosa to pull out of the Chairman’s Conversation.
Mkhari said he understood why the president did it, but he was disappointed at the decision.
The annual Chairman’s Conversation was cancelled on Thursday evening after Ramaphosa withdrew, citing concerns raised by civil society organisations about his participation.
Mkhari and his wife, Ipeleng, were embroiled in a domestic dispute last year, which saw them laying criminal complaints against one another, which were later withdrawn.
Mkhari had to cancel the event after the Ramaphosa’s withdrawal.
Mkhari said: “I believe that there are multiple considerations that the highest office in the land would go through and arriving at a decision and, we respect it and accept it.”
The Mkhari’s domestic issues were the reason that Ramaphosa pulled out after numerous organisations complained that Mkhari had faced allegations that he abused his wife.
But Ipeleng denied this: “At the time last year when we went through one of the most difficult time of our lives, we decided to make that process our process and to look at the genesis of time and what has happened over that time, a lot of healing has taken place between us and our families and amongst a greater part of the people around us.”
The couple said they had resolved their issues and would like the public to respect this.


|
|
#include <pantheios/inserters/real.hpp>
This class converts a floating-point variable into a string, thereby enabling it to be inserted into a logging statement. Consider the following statement
double d = 123.456; char s[] = "abc"; std::string str("def"); pantheios::log(pantheios::notice, "s=", s, ", d=", pantheios::real(d), ", str=", str);
This will produce the output:
s=abc, d=123.456, str=def
cpp/inserters/example.cpp.inserter.real/example.cpp.inserter.real.cpp, and cpp/misc/example.cpp.misc.101/example.cpp.misc.101.cpp.
Public Types | |
| typedef real | class_type |
| This type. | |
Public Member Functions | |
| real (float value, int widthAndFormat=0) | |
| Construct from a float value. | |
| real (double value, int widthAndFormat=0) | |
| Construct from a double value. | |
| real (long double value, int widthAndFormat=0) | |
| Construct from a long double value. | |
| pan_char_t const * | data () const |
| A possibly non-nul-terminated non-null pointer to the c-style string representation of the floating-point number. | |
| pan_char_t const * | c_str () const |
| A nul-terminated non-null pointer to the c-style string representation of the floating-point number. | |
| size_t | length () const |
| The length of the c-style string representation of the floating-point number. | |
Classes | |
| union | u |
| typedef real class_type |
This type.
| real | ( | float | value, | |
| int | widthAndFormat = 0 | |||
| ) | [explicit] |
Construct from a float value.
| value | The value to be inserted | |
| widthAndFormat | Not currently used |
| real | ( | double | value, | |
| int | widthAndFormat = 0 | |||
| ) | [explicit] |
Construct from a double value.
| value | The value to be inserted | |
| widthAndFormat | Not currently used |
| real | ( | long double | value, | |
| int | widthAndFormat = 0 | |||
| ) | [explicit] |
Construct from a long double value.
| value | The value to be inserted | |
| widthAndFormat | Not currently used |
| pan_char_t const* data | ( | ) | const |
A possibly non-nul-terminated non-null pointer to the c-style string representation of the floating-point number.
| pan_char_t const* c_str | ( | ) | const |
A nul-terminated non-null pointer to the c-style string representation of the floating-point number.
| size_t length | ( | ) | const |
The length of the c-style string representation of the floating-point number.
|
|
|
| pantheios Library documentation © Matthew Wilson & Synesis Software, 2006-2011 |


|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.commerce.csr.returns.ReturnRequest
public class ReturnRequest
This component encapsulates all data related to a request to return or exchange merchandise.
The loadReturnRequest(RepositoryItem)
is used to load return request properties from repository item.
if you add additional properties to return request and it needs to be loaded to the return request object, you need
to extend this method.
The saveReturnRequest(MutableRepositoryItem)
is used to save return request properties to repository item.
if you add additional properties to return request and it needs to be saved in the repository, you need
to extend this method.
loadReturnRequest(RepositoryItem)
,
saveReturnRequest(MutableRepositoryItem)
,
Serialized Form| Field Summary | |
|---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected java.util.Map |
mDiscountableMap
|
protected java.util.Map |
mExchangeManualAdjustmentValue
|
protected java.util.Map |
mExchangeOrderPromotionValue
|
protected java.util.Map |
mExchangeToPEOItemMap
|
protected java.util.Map |
mExchangeToPEOShippingGroupMap
|
protected java.util.Map<atg.commerce.promotion.GWPMultiHashKey,GiftWithPurchaseSelection> |
mGWPSelections
|
protected java.util.List |
mItemPriceSources
|
protected java.util.Collection |
mItemPromotions
|
protected java.util.Collection |
mNonReturnItemCostAdjustments
|
protected double |
mNonReturnItemSubtotalAdjustment
|
protected java.util.Collection |
mOrderPromotions
|
protected Order |
mOriginatingOrder
|
protected java.util.Map |
mOriginatingToRAOItemMap
|
protected java.util.Map |
mOriginatingToRAOShippingGroupMap
|
protected java.util.Map |
mPEOToExchangeItemMap
|
protected java.util.Map |
mPEOToExchangeShippingGroupMap
|
protected java.util.Map |
mPEOToRCOItemMap
|
protected java.util.Map |
mPEOToRCOShippingGroupMap
|
protected java.util.Map |
mPreReturnPromotionValue
|
protected RepositoryItem |
mPriceList
|
protected Order |
mPromotionEvaluationOrder
|
protected java.util.Map |
mPromotionValueAdjustment
|
protected java.util.Map |
mRAOToOriginatingItemMap
|
protected java.util.Map |
mRAOToOriginatingShippingGroupMap
|
protected java.util.Map |
mRAOToRCOItemMap
|
protected java.util.Map |
mRAOToRCOShippingGroupMap
|
protected java.util.Map |
mRAOToReplacementItemMap
|
protected java.util.Map |
mRAOToReplacementShippingGroupMap
|
protected java.util.Map |
mRCOToPEOItemMap
|
protected java.util.Map |
mRCOToPEOShippingGroupMap
|
protected java.util.Map |
mRCOToRAOItemMap
|
protected java.util.Map |
mRCOToRAOShippingGroupMap
|
protected java.util.List |
mRelatedReplacementOrders
|
protected java.util.Map |
mReplacementToRAOItemMap
|
protected java.util.Map |
mReplacementToRAOShippingGroupMap
|
protected Order |
mReturnAdjustedOrder
|
protected Order |
mReturnCalculationOrder
|
protected RepositoryItem |
mSalePriceList
|
protected java.util.Map |
mShippingCostMap
|
protected java.lang.Object[] |
mSortedRelatedReturnRequests
|
| Constructor Summary | |
|---|---|
ReturnRequest()
Initializes a ReturnRequest object with a null order |
|
ReturnRequest(Order pOrder)
Initializes a ReturnRequest object based on the given order. |
| Method Summary | |
|---|---|
void |
addNonReturnItemCostAdjustment(ItemCostAdjustment pItemCostAdjustment)
Adds a new ItemCostAdjustment to the return. |
void |
addNonReturnItemCostAdjustments(java.util.Collection pNonReturnItemCostAdjustments)
Adds a collection of ItemCostAdjustment objects to the return. |
void |
clearNonReturnItemCostAdjustments()
Clears all the ItemCostAdjustment objects from the return |
double |
getActualShippingRefund()
Returns the actual shipping cost refund amount |
double |
getActualTaxRefund()
Returns the actual tax refund amount |
double |
getAdjustmentAmount()
returns the total amount of adjustments. |
java.lang.String |
getAgentId()
Gets property agentId |
double |
getAllocatedAmount()
Returns the total refund amount that has been allocated to refund methods. |
java.util.Date |
getAuthorizationDate()
Returns authorization date |
java.lang.String |
getAuthorizationNumber()
Returns authorization number |
java.lang.String |
getComments()
returns the comments about this return |
atg.commerce.csr.returns.ProcessName |
getCurrentProcessName()
This method gets the current process name. If the process name is null, then based on the replacement order, this method sets to Return or Exchange. |
java.util.Map |
getDiscountableMap()
Returns the Map of discountable flags based on the state saved on the originating order and all related replacement orders. |
java.util.Map |
getExchangeManualAdjustmentValue()
Returns the map of manual adjustment to their adjustment value. |
java.util.Map |
getExchangeOrderPromotionValue()
Returns the map of order promotion to their adjustment value. |
java.util.Map |
getExchangeToPEOItemMap()
This maps items in the new exchange order to their matching counterpart in the promotion evaluation order. |
java.util.Map |
getExchangeToPEOShippingGroupMap()
This maps shipping groups in the new exchange order to their matching counterpart in the promotion evaluation order. |
StoreCredit |
getGeneratedStoreCredit()
Returns the generatedStoreCredit. |
RepositoryItem |
getGeneratedStoreCreditItem()
Returns the transient repository item matching the generatedStoreCredit. |
java.util.Map<atg.commerce.promotion.GWPMultiHashKey,GiftWithPurchaseSelection> |
getGWPSelections()
These GiftWithPurchaseSelection objects are generated based on
the gwp items that are being exchanged. |
static ReturnRequest |
getInstance()
Deprecated. |
static ReturnRequest |
getInstance(Order pOrder)
Deprecated. |
java.util.List |
getItemPriceSources()
Returns the list of ItemPriceSource objects that are used
to price the working orders and the exchange order in the return. |
java.util.Collection |
getItemPromotions()
|
java.util.Collection |
getNonReturnItemCostAdjustments()
Returns the collection of ItemCostAdjustment objects
that were generated for items not being returned and
included when calculating the suggested refund amounts for the
return. |
double |
getNonReturnItemSubtotalAdjustment()
This is the adjustment to the totalItemRefund
based on the adjustments to non-return item's
amount, order discount share and manual adjustment share |
Order |
getOrder()
returns the the order that this return is related to |
java.util.Collection |
getOrderPromotions()
|
Order |
getOriginatingOrder()
Returns the originating order for this return request. |
java.util.Map |
getOriginatingToRAOItemMap()
Maps the commerce item ids in the originating order to their matching counterparts in the Return Adjusted Order. |
java.util.Map |
getOriginatingToRAOShippingGroupMap()
Maps the shipping group ids in the originating order to their matching counterparts in the Return Adjusted Order. |
java.lang.String |
getOriginOfReturn()
Returns property originOfReturn |
double |
getOtherRefund()
|
java.util.Map |
getPEOToExchangeItemMap()
This maps items in the promotion evaluation order to their matching counterpart in the new exchange order. |
java.util.Map |
getPEOToExchangeShippingGroupMap()
This maps shipping groups in the promotion evaluation order to their matching counterpart in the new exchange order. |
java.util.Map |
getPEOToRCOItemMap()
This maps items in the promotion evaluation order to their matching counter part in the return calculation order. |
java.util.Map |
getPEOToRCOShippingGroupMap()
This maps items in the promotion evaluation order to their matching counter part in the return calculation order. |
java.util.Map |
getPreReturnPromotionValue()
This map contains the adjustment value of each promotion at the start of the return. |
RepositoryItem |
getPriceList()
|
atg.commerce.csr.returns.ProcessName |
getProcessName()
|
RepositoryItem |
getProfile()
|
Order |
getPromotionEvaluationOrder()
Returns a reference to the PromotionEvaluationOrder created for the exchange. |
java.util.Map |
getPromotionValueAdjustments()
This map contains the change in promotion value as a result of the current return or exchange. |
java.util.Map |
getRAOToOriginatingItemMap()
Maps the commerce item ids in the Return Adjusted Order to their matching counterparts in the originating order. |
java.util.Map |
getRAOToOriginatingShippingGroupMap()
Maps the shipping group ids in the Return Adjusted Order to their matching counterparts in the originating order. |
java.util.Map |
getRAOToRCOItemMap()
This maps items in the return adjusted order to their matching counter part in the return calculation order. |
java.util.Map |
getRAOToRCOShippingGroupMap()
This maps shipping groups in the return adjusted order to their matching counter part in the return calculation order. |
java.util.Map |
getRAOToReplacementItemMap()
The maps RAO item ids to their original replacement item ids |
java.util.Map |
getRAOToReplacementShippingGroupMap()
The maps RAO shipping group ids to their original replacement shipping group ids |
java.util.Map |
getRCOToPEOItemMap()
This maps items in the return calcuation order to their matching counter part in the promotion evaluation order. |
java.util.Map |
getRCOToPEOShippingGroupMap()
This maps items in the return calculation order to their matching counter part in the promotin evaluation order. |
java.util.Map |
getRCOToRAOItemMap()
This maps items in the return calculation order to their matching counter part in the return adjusted order. |
java.util.Map |
getRCOToRAOShippingGroupMap()
This maps shipping groups in the return calcuation order to their matching counter part in the return adjusted order. |
java.util.ArrayList<RefundMethod> |
getRefundMethodList()
Returns list of refund methods that are available |
double |
getRefundSubtotal()
Returns the subtotal amount of this refund. |
java.util.List |
getRelatedReplacementOrders()
This list includes all the replacement orders associated with the sortedReturnRequests |
long |
getReplaceItemCount()
The number of items being replaced. |
Order |
getReplacementOrder()
|
java.util.Map |
getReplacementToRAOItemMap()
This maps items copied from each exchange order to their counterpart in the return adjusted order. |
java.util.Map |
getReplacementToRAOShippingGroupMap()
This maps shipping groups in the exchange orders to their matching counter parts in the return adjusted order. |
java.lang.String |
getRequestId()
returns the ID of the request that this object represents |
Order |
getReturnAdjustedOrder()
Returns a reference to the ReturnAdjustedOrder created for the return. |
Order |
getReturnCalculationOrder()
Returns a reference to the ReturnCalculationOrder created for the return. |
double |
getReturnFee()
Returns the fee associated with the return |
long |
getReturnItemCount()
The number of items being returned |
java.util.ArrayList |
getReturnItemList()
Returns list of items selected for inclusion in this return |
java.util.HashMap |
getReturnItemMap()
Returns map of ReturnItem Ids to the ReturnItems |
atg.commerce.csr.returns.ReturnPaymentState |
getReturnPaymentState()
Returns the returnPaymentState. |
RepositoryItem |
getSalePriceList()
|
java.util.Map |
getShippingCostMap()
Maps ShippingGroupCommerceItemRelationships to the their shipping cost in the original purchase order |
java.util.ArrayList |
getShippingGroupList()
Returns list of shipping groups associated with this return request |
java.util.HashMap |
getShippingGroupMap()
Returns list of shipping groups associated with this return request |
java.lang.Object[] |
getSortedRelatedReturnRequests()
Returns a reference to the sorted array of related return request objects |
java.lang.String |
getState()
The state of this return request |
java.lang.String |
getStateAsUserResource()
returns the ReturnRequest state as a user resource |
java.lang.String |
getStateDetailAsUserResource()
returns the ReturnRequest state detail as a user resource |
double |
getSuggestedShippingRefund()
returns the suggested shipping cost refund amount |
double |
getSuggestedTaxRefund()
returns the suggested tax refund amount |
double |
getTotalItemRefund()
This method returns the item subtotal for this refund, not including refund for taxes & shipping. |
double |
getTotalRefundAmount()
returns the total amount of this refund, less the return fee |
double |
getTotalReturnItemRefund()
Returns the total refund for the items being returned. |
double |
getUnallocatedAmount()
Returns the total refund amount that is not allocated to a refund method. |
boolean |
isExchangeProcess()
This is the utility method to find whether the current process is the exchange process or not. |
boolean |
isProcessed()
returns boolean indicating if this request has been processed |
boolean |
isProcessImmediately()
returns the 'process immediately' setting |
boolean |
isReplacingItems()
Deprecated. |
boolean |
isReturningItems()
Are we returning one or more items? |
boolean |
isReturnProcess()
This is the utility method to find whether the current process is the return process or not. |
void |
loadReturnRequest(RepositoryItem pSource)
This method is used to copy the information from the source return request repository item to return request instance. |
void |
saveReturnRequest(MutableRepositoryItem pDestination)
This method is used to copy the information from return request instance to repository item. |
void |
setActualShippingRefund(double pActualShippingRefund)
Sets the actual shipping cost refund amount |
void |
setActualTaxRefund(double pActualTaxRefund)
Sets the actual tax refund amount |
void |
setAgentId(java.lang.String pAgentId)
Sets agentId |
void |
setAuthorizationDate(java.util.Date pAuthorizationDate)
Sets authorization date |
void |
setAuthorizationNumber(java.lang.String pAuthorizationNumber)
Sets authorization number |
void |
setComments(java.lang.String pComments)
sets the comments about this return |
void |
setDiscountableMap(java.util.Map pDiscountableState)
|
void |
setExchangeManualAdjustmentValue(java.util.Map pExchangeManualAdjustmentValue)
|
void |
setExchangeOrderPromotionValue(java.util.Map pExchangeOrderPromotionValue)
|
void |
setExchangeToPEOItemMap(java.util.Map pExchangeToPEOItemMap)
|
void |
setExchangeToPEOShippingGroupMap(java.util.Map pExchangeToPEOShippingGroupMap)
|
void |
setGeneratedStoreCredit(StoreCredit pGeneratedStoreCredit)
|
void |
setGeneratedStoreCredit(StoreCredit pGeneratedStoreCredit,
RepositoryItem pItem)
Sets the generatedStoreCredit. |
void |
setGWPSelections(java.util.Map<atg.commerce.promotion.GWPMultiHashKey,GiftWithPurchaseSelection> pGWPSelections)
|
void |
setItemPriceSources(java.util.List pItemPriceSources)
Sets the list of ItemPriceSource objects that are used
to price the working orders and the exchange order in the return. |
void |
setItemPromotions(java.util.Collection pItemPromotions)
Sets the Collection of item level promotions used to calculate pricing of the Return Adjusted, Return Calculation and Promotion Evaluation Orders. |
void |
setNonReturnItemSubtotalAdjustment(double pNonReturnItemSubtotalAdjustment)
|
protected void |
setOrder(Order pOrder)
sets the the order that this return is related to |
void |
setOrderPromotions(java.util.Collection pOrderPromotions)
Sets the Collection of order level promotions used to calculate pricing of the Return Adjusted, Return Calculation and Promotion Evaluation Orders. |
void |
setOriginatingOrder(Order pOriginatingOrder)
|
void |
setOriginatingToRAOItemMap(java.util.Map pOriginatingToRAOItemMap)
|
void |
setOriginatingToRAOShippingGroupMap(java.util.Map pOriginatingToRAOShippingGroupMap)
|
void |
setOriginOfReturn(java.lang.String pOriginOfReturn)
Sets property originOfReturn |
void |
setOtherRefund(double pOtherRefund)
|
void |
setPEOToRCOItemMap(java.util.Map pPEOToRCOItemMap)
|
void |
setPEOToRCOShippingGroupMap(java.util.Map pPEOToRCOShippingGroupMap)
|
void |
setPreReturnPromotionValue(java.util.Map pPreReturnPromotionValue)
|
void |
setPriceList(RepositoryItem pPriceList)
|
void |
setProcessed(boolean pProcessed)
sets boolean indicating if this request has been processed |
void |
setProcessImmediately(boolean pProcessImmediately)
sets the 'process immediately' setting |
void |
setProcessName(atg.commerce.csr.returns.ProcessName pProcessName)
|
void |
setProfile(RepositoryItem pProfile)
|
void |
setPromotionEvaluationOrder(Order pPromotionEvaluationOrder)
|
void |
setPromotionValueAdjustments(java.util.Map pPromotionValueAdjustment)
|
void |
setRAOToOriginatingItemMap(java.util.Map pRAOToOriginatingItemMap)
|
void |
setRAOToOriginatingShippingGroupMap(java.util.Map pRAOToOriginatingShippingGroupMap)
|
void |
setRAOToRCOItemMap(java.util.Map pRAOToRCOItemMap)
|
void |
setRAOToRCOShippingGroupMap(java.util.Map pRAOToRCOShippingGroupMap)
|
void |
setRCOToPEOItemMap(java.util.Map pRCOToPEOItemMap)
|
void |
setRCOToPEOShippingGroupMap(java.util.Map pRCOToPEOShippingGroupMap)
|
void |
setRCOToRAOItemMap(java.util.Map pRCOToRAOItemMap)
|
void |
setRCOToRAOShippingGroupMap(java.util.Map pRCOToRAOShippingGroupMap)
|
void |
setRelatedReplacementOrders(java.util.List pRelatedReplacementOrders)
|
protected void |
setReplacementOrder(Order pReplacementOrder)
sets the replacement order |
void |
setReplacementToRAOItemMap(java.util.Map pReplacementToRAOItemMap)
|
void |
setReplacementToRAOShippingGroupMap(java.util.Map pReplacementToRAOShippingGroupMap)
|
protected void |
setRequestId(java.lang.String pRequestId)
sets the ID of the request that this object represents |
void |
setReturnAdjustedOrder(Order pReturnAdjustedOrder)
|
void |
setReturnCalculationOrder(Order pReturnCalculationOrder)
|
void |
setReturnFee(double pReturnFee)
Sets the fee associated with a return |
void |
setReturnPaymentState(atg.commerce.csr.returns.ReturnPaymentState pReturnPaymentState)
Sets the returnPaymentState. |
void |
setSalePriceList(RepositoryItem pSalePriceList)
|
void |
setShippingCostMap(java.util.Map pShippingCostMap)
|
void |
setSortedRelatedReturnRequests(java.lang.Object[] pSortedRelatedReturnRequests)
|
protected void |
setState(java.lang.String pState)
sets the state of this return request |
protected void |
setSuggestedShippingRefund(double pSuggestedShippingRefund)
sets the suggested shipping cost refund amount |
protected void |
setSuggestedTaxRefund(double pSuggestedTaxRefund)
sets the suggested tax refund amount |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String CLASS_VERSION
protected java.util.Map mDiscountableMap
protected RepositoryItem mPriceList
protected RepositoryItem mSalePriceList
protected double mNonReturnItemSubtotalAdjustment
protected java.lang.Object[] mSortedRelatedReturnRequests
protected Order mReturnAdjustedOrder
protected java.util.Map mOriginatingToRAOItemMap
protected java.util.Map mRAOToOriginatingItemMap
protected java.util.Map mOriginatingToRAOShippingGroupMap
protected java.util.Map mRAOToOriginatingShippingGroupMap
protected Order mReturnCalculationOrder
protected java.util.Map mRAOToRCOItemMap
protected java.util.Map mRCOToRAOItemMap
protected java.util.Map mRAOToRCOShippingGroupMap
protected java.util.Map mRCOToRAOShippingGroupMap
protected Order mPromotionEvaluationOrder
protected java.util.Map mRCOToPEOItemMap
protected java.util.Map mPEOToRCOItemMap
protected java.util.Map mPEOToRCOShippingGroupMap
protected java.util.Map mRCOToPEOShippingGroupMap
protected java.util.Map mExchangeToPEOItemMap
protected java.util.Map mPEOToExchangeItemMap
protected java.util.Map mReplacementToRAOItemMap
protected java.util.Map mReplacementToRAOShippingGroupMap
protected java.util.Map mRAOToReplacementItemMap
protected java.util.Map mRAOToReplacementShippingGroupMap
protected java.util.Map mExchangeToPEOShippingGroupMap
protected java.util.Map mPEOToExchangeShippingGroupMap
protected Order mOriginatingOrder
protected java.util.Collection mItemPromotions
protected java.util.Collection mOrderPromotions
protected java.util.Map mExchangeOrderPromotionValue
protected java.util.Map mExchangeManualAdjustmentValue
protected java.util.Map mShippingCostMap
protected java.util.Map mPreReturnPromotionValue
protected java.util.Map mPromotionValueAdjustment
protected java.util.List mRelatedReplacementOrders
protected java.util.Collection mNonReturnItemCostAdjustments
protected java.util.List mItemPriceSources
protected java.util.Map<atg.commerce.promotion.GWPMultiHashKey,GiftWithPurchaseSelection> mGWPSelections
| Constructor Detail |
|---|
public ReturnRequest()
public ReturnRequest(Order pOrder)
ReturnTools.getReturnShippingGroups(Order)
| Method Detail |
|---|
public java.util.Map getDiscountableMap()
This Map is passed to all pricing operations on the working orders to preserve the original discountable state of the items.
public void setDiscountableMap(java.util.Map pDiscountableState)
public RepositoryItem getPriceList()
public void setPriceList(RepositoryItem pPriceList)
public RepositoryItem getSalePriceList()
public void setSalePriceList(RepositoryItem pSalePriceList)
public RepositoryItem getProfile()
This value is filled in when the return request is initialized based on the
profileId referenced by the Order
public void setProfile(RepositoryItem pProfile)
public atg.commerce.csr.returns.ReturnPaymentState getReturnPaymentState()
public void setReturnPaymentState(atg.commerce.csr.returns.ReturnPaymentState pReturnPaymentState)
pReturnPaymentState
- public StoreCredit getGeneratedStoreCredit()
public void setGeneratedStoreCredit(StoreCredit pGeneratedStoreCredit, RepositoryItem pItem)
pGeneratedStoreCredit
- the StoreCredit holder for the creditpItem
- the repository item for the store credit, if you have it it helps failoverpublic void setGeneratedStoreCredit(StoreCredit pGeneratedStoreCredit)
public RepositoryItem getGeneratedStoreCreditItem()
public double getOtherRefund()
public void setOtherRefund(double pOtherRefund)
pOtherRefund
- The otherRefund to set.public double getNonReturnItemSubtotalAdjustment()
totalItemRefund
based on the adjustments to non-return item's
amount, order discount share and manual adjustment share
This value is updated whenever the suggested amounts are (re)calculated for the return and when the return request is loaded from the repository.
Note that tax and shipping adjustments to non-return items are accounted for in the suggested and actual tax and shipping refund amounts.
This value is not persisted to the repository
public void setNonReturnItemSubtotalAdjustment(double pNonReturnItemSubtotalAdjustment)
pNonReturnItemSubtotalAdjustment
- The nonReturnItemRefundSubtotalAdjustment to set.public atg.commerce.csr.returns.ProcessName getProcessName()
ProcessName.Return
public void setProcessName(atg.commerce.csr.returns.ProcessName pProcessName)
pProcessName
- The processName to set.public void setActualShippingRefund(double pActualShippingRefund)
pActualShippingRefund
- the actual shipping cost refund amountpublic double getActualShippingRefund()
public void setActualTaxRefund(double pActualTaxRefund)
pActualTaxRefund
- the actual tax refund amountpublic double getActualTaxRefund()
public void setAuthorizationDate(java.util.Date pAuthorizationDate)
pAuthorizationDate
- the authorization datepublic java.util.Date getAuthorizationDate()
public void setAuthorizationNumber(java.lang.String pAuthorizationNumber)
pAuthorizationNumber
- the authorization numberpublic java.lang.String getAuthorizationNumber()
public void setComments(java.lang.String pComments)
pComments
- the comments about this returnpublic java.lang.String getComments()
protected void setOrder(Order pOrder)
pOrder
- the order that this return is related topublic Order getOrder()
public void setProcessed(boolean pProcessed)
pProcessed
- a boolean indicating if this request has been processedpublic boolean isProcessed()
public void setProcessImmediately(boolean pProcessImmediately)
pProcessImmediately
- a boolean indicating if this request should be processed immediatelypublic boolean isProcessImmediately()
public java.util.ArrayList<RefundMethod> getRefundMethodList()
protected void setReplacementOrder(Order pReplacementOrder)
pReplacementOrder
- the replacement orderpublic Order getReplacementOrder()
protected void setRequestId(java.lang.String pRequestId)
pRequestId
- the ID of the request that this object representspublic java.lang.String getRequestId()
public void setReturnFee(double pReturnFee)
pReturnFee
- the fee associated with a returnpublic double getReturnFee()
public java.util.ArrayList getReturnItemList()
public java.util.HashMap getReturnItemMap()
public java.util.ArrayList getShippingGroupList()
public java.util.HashMap getShippingGroupMap()
protected void setState(java.lang.String pState)
pState
- the state of this return requestpublic java.lang.String getState()
public java.lang.String getStateAsUserResource()
public java.lang.String getStateDetailAsUserResource()
protected void setSuggestedShippingRefund(double pSuggestedShippingRefund)
pSuggestedShippingRefund
- the suggested shipping cost refund amountpublic double getSuggestedShippingRefund()
protected void setSuggestedTaxRefund(double pSuggestedTaxRefund)
pSuggestedTaxRefund
- the suggested tax refund amountpublic double getSuggestedTaxRefund()
public java.lang.String getAgentId()
public void setAgentId(java.lang.String pAgentId)
pAgentId
- public java.lang.String getOriginOfReturn()
public void setOriginOfReturn(java.lang.String pOriginOfReturn)
pOriginOfReturn
- public double getAllocatedAmount()
This method walks through the refund methods and sums up the RefundMethod.getAmount()
.
If you want to turn on logging debug for this class, turn on GenericService.isLoggingDebug()
.
public double getTotalItemRefund()
nonReturnItemSubtotalAdjustment
value.
If you want to turn on logging debug for this class, turn on GenericService.isLoggingDebug()
.
public double getTotalReturnItemRefund()
This value is calculated by iterating over the return items and totaling the ReturnItem.getRefundAmount()
public double getRefundSubtotal()
public double getAdjustmentAmount()
The basic formula is: ActualShippingRefund + ActualTaxRefund + OtherRefund - ReturnFee
public double getTotalRefundAmount()
The basic formula is: RefundSubtotalAmount + TotalAdjustmentAmount
public double getUnallocatedAmount()
The basic formula is: TotalRefundAmount - TotalAllocatedAmount
getAllocatedAmount()
public long getReplaceItemCount()
public boolean isReplacingItems()
public long getReturnItemCount()
public boolean isReturningItems()
public boolean isExchangeProcess()
If the current process is the exchange process this method returns true. Otherwise returns false.
If the processName is not set on the ReturnRequest, this method checks to see, if there is an replacement
order. If there is an replacement order exists, then this method sets the processName as Exchange and returns
true. If there is no replacement order, then this method sets the processName as Return and returns false.
public boolean isReturnProcess()
If the current process is the return process this method returns true. Otherwise returns false.
If the processName is not set on the ReturnRequest, this method checks to see, if there is an replacement
order. If there is an replacement order exists, then this method sets the processName as Exchange and returns
false. If there is no replacement order, then this method sets the processName as Return and returns true.
public atg.commerce.csr.returns.ProcessName getCurrentProcessName()
public static ReturnRequest getInstance()
ReturnRequest()
to create ReturnRequest
.
public static ReturnRequest getInstance(Order pOrder)
ReturnRequest(Order)
to create ReturnRequest
.
pOrder
- The order which is used to initialize ReturnShippingGroup
and ReturnItem
.
public java.lang.Object[] getSortedRelatedReturnRequests()
public void setSortedRelatedReturnRequests(java.lang.Object[] pSortedRelatedReturnRequests)
public Order getReturnAdjustedOrder()
The return adjusted order provides a context in which all items still owned by the customer are put into a single order where they can be priced together
public void setReturnAdjustedOrder(Order pReturnAdjustedOrder)
public java.util.Map getOriginatingToRAOItemMap()
public void setOriginatingToRAOItemMap(java.util.Map pOriginatingToRAOItemMap)
public java.util.Map getRAOToOriginatingItemMap()
public void setRAOToOriginatingItemMap(java.util.Map pRAOToOriginatingItemMap)
public java.util.Map getOriginatingToRAOShippingGroupMap()
public void setOriginatingToRAOShippingGroupMap(java.util.Map pOriginatingToRAOShippingGroupMap)
public java.util.Map getRAOToOriginatingShippingGroupMap()
public void setRAOToOriginatingShippingGroupMap(java.util.Map pRAOToOriginatingShippingGroupMap)
public Order getReturnCalculationOrder()
The return calculation order provides a context in which all items still owned by the customer, minus the items being returned in the current request, are put into a single order where they can be priced together
public void setReturnCalculationOrder(Order pReturnCalculationOrder)
public java.util.Map getRAOToRCOItemMap()
public void setRAOToRCOItemMap(java.util.Map pRAOToRCOItemMap)
public java.util.Map getRCOToRAOItemMap()
public void setRCOToRAOItemMap(java.util.Map pRCOToRAOItemMap)
public java.util.Map getRAOToRCOShippingGroupMap()
public void setRAOToRCOShippingGroupMap(java.util.Map pRAOToRCOShippingGroupMap)
public java.util.Map getRCOToRAOShippingGroupMap()
public void setRCOToRAOShippingGroupMap(java.util.Map pRCOToRAOShippingGroupMap)
public Order getPromotionEvaluationOrder()
The promotion evaluation order provides a context in which all items still owned by the customer, minus the items being returned in the current request, are put into a single order along with the exchange items where they can be priced together
public void setPromotionEvaluationOrder(Order pPromotionEvaluationOrder)
public java.util.Map getRCOToPEOItemMap()
public void setRCOToPEOItemMap(java.util.Map pRCOToPEOItemMap)
public java.util.Map getPEOToRCOItemMap()
public void setPEOToRCOItemMap(java.util.Map pPEOToRCOItemMap)
public java.util.Map getPEOToRCOShippingGroupMap()
public void setPEOToRCOShippingGroupMap(java.util.Map pPEOToRCOShippingGroupMap)
public java.util.Map getRCOToPEOShippingGroupMap()
public void setRCOToPEOShippingGroupMap(java.util.Map pRCOToPEOShippingGroupMap)
public void setExchangeToPEOItemMap(java.util.Map pExchangeToPEOItemMap)
public java.util.Map getExchangeToPEOItemMap()
public java.util.Map getPEOToExchangeItemMap()
Note this map is generated whenever a new exchangeItemToPEOItemMap
is
set.
public void setReplacementToRAOItemMap(java.util.Map pReplacementToRAOItemMap)
public java.util.Map getReplacementToRAOItemMap()
public void setReplacementToRAOShippingGroupMap(java.util.Map pReplacementToRAOShippingGroupMap)
public java.util.Map getReplacementToRAOShippingGroupMap()
public java.util.Map getRAOToReplacementItemMap()
This Map is auto-generated whenever the replacementItemMap
is
set.
public java.util.Map getRAOToReplacementShippingGroupMap()
This Map is auto-generated whenever the replacementShippingGroupMap
is
set.
public void setExchangeToPEOShippingGroupMap(java.util.Map pExchangeToPEOShippingGroupMap)
public java.util.Map getExchangeToPEOShippingGroupMap()
public java.util.Map getPEOToExchangeShippingGroupMap()
Note this map is generated whenever a new exchangeShippingGroupToPEOShippingGroupMap
is
set.
public void setOriginatingOrder(Order pOriginatingOrder)
public Order getOriginatingOrder()
The originating order is the first order purchase from which all returns and exchanges originated.
pOriginatingOrder
- public java.util.Collection getItemPromotions()
public void setItemPromotions(java.util.Collection pItemPromotions)
public java.util.Collection getOrderPromotions()
public void setOrderPromotions(java.util.Collection pOrderPromotions)
public java.util.Map getExchangeOrderPromotionValue()
ExchangeOrderDiscountCalculator
to
apply order discounts to the exchange order.
This map is generated based on the value of order promotions against the replacement items in the promotion evaluation order
public void setExchangeOrderPromotionValue(java.util.Map pExchangeOrderPromotionValue)
public java.util.Map getExchangeManualAdjustmentValue()
ExchangeOrderAdjustmentCalculator
to
apply manual adjustments to the exchange order
This map is generated based on the value of manual adjustments against the replacement items in the promotion evaluation order
public void setExchangeManualAdjustmentValue(java.util.Map pExchangeManualAdjustmentValue)
public java.util.Map getShippingCostMap()
The values in this map are used to determine the shipping refund for return items.
public void setShippingCostMap(java.util.Map pShippingCostMap)
public java.util.Map getPreReturnPromotionValue()
This map is generated once at the start of the return and is used to calculate the change in promotion value by comparing to the promotion value in the Return Calculation Order or Promotion Evaluation Order, depending on whether a return or exchange is being done.
public void setPreReturnPromotionValue(java.util.Map pPreReturnPromotionValue)
public java.util.Map getPromotionValueAdjustments()
public void setPromotionValueAdjustments(java.util.Map pPromotionValueAdjustment)
public java.util.List getRelatedReplacementOrders()
sortedReturnRequests
It is used to determine all the items and shipping groups that should be added to the Return Adjusted Orders as well as determining the payment groups available to receive a refund.
public void setRelatedReplacementOrders(java.util.List pRelatedReplacementOrders)
public java.util.Collection getNonReturnItemCostAdjustments()
ItemCostAdjustment
objects
that were generated for items not being returned and
included when calculating the suggested refund amounts for the
return.
public void addNonReturnItemCostAdjustment(ItemCostAdjustment pItemCostAdjustment)
ItemCostAdjustment
to the return.
pItemCostAdjustment
- public void addNonReturnItemCostAdjustments(java.util.Collection pNonReturnItemCostAdjustments)
ItemCostAdjustment
objects to the return.
pNonReturnItemCostAdjustments
- public void clearNonReturnItemCostAdjustments()
ItemCostAdjustment
objects from the return
public java.util.List getItemPriceSources()
ItemPriceSource
objects that are used
to price the working orders and the exchange order in the return.
This list is automatically generated for all returns and exchanges based on the original order and any exchange order in the return tree. This maintains the original prices for the items to avoid inaccurate refund calculations when product prices have changed since the purchase.
ItemPriceSource
objectspublic void setItemPriceSources(java.util.List pItemPriceSources)
ItemPriceSource
objects that are used
to price the working orders and the exchange order in the return.
public java.util.Map<atg.commerce.promotion.GWPMultiHashKey,GiftWithPurchaseSelection> getGWPSelections()
GiftWithPurchaseSelection
objects are generated based on
the gwp items that are being exchanged. These are used to present selection
links on the exchange order cart page.
The objects are generated whenever return items are selected by the agent.
ReturnManager.generateGWPSelectionsForReturnItems(ReturnRequest)
,
ReturnManager.generateFilteredReturnRequestSelections(ReturnRequest)
,
atg.commerce.csr.promotion.CSRGiftWithPurchaseSelectionsDroplet
public void setGWPSelections(java.util.Map<atg.commerce.promotion.GWPMultiHashKey,GiftWithPurchaseSelection> pGWPSelections)
public void loadReturnRequest(RepositoryItem pSource) throws ReturnException
pSource
- The information to be copied from.
ReturnException
public void saveReturnRequest(MutableRepositoryItem pDestination) throws ReturnException
pDestination
- The information to be copied
ReturnException
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |


Summer Intern: MCL @ BU
I worked at the Multimedia Communications Lab at Boston University as an undergraduate summer intern. The lab focuses on Visible Light Communications. I worked on the network simulations using ns-3 module.
Research Assistant: MIT D'Arbeloff Lab
I worked as a undergraduate research assistant for a MIT PhD candidate. The research lab focused on building underwater drones for various purposes. In a team of four, we built an underwater drone from scratch. It was an interdisciplinary team. I got learn a lot of SolidWorks as well as simple machining. The drone was controlled with an Arduino and I was mostly in charge of the software as well as the controls of the drone.
Summer Intern: Cloudfactory
In the summer of 2014, I decided to go to Nepal and intern at Cloudfactory as a front end developer. Cloudfactory is a technology company headquartered in Kathmandu, Nepal. Their clients include various companies across USA, Canada and the UK. The company has an efficient and strong API-driven workforce for various purposes such as data and receipt transcription, image and video tagging, machine learning and many more services. I interned in the UI/UX team to create numerous webpages for the cloudworkers to do the various transcription jobs.
ECE IT Lab Assistant
Worked as an Lab IT Assistant at Boston University's Electrical and Computer Engineering Department. My responsibilities included maintaining the computers as well as other technologies in the instructional labs of the department. The department worked closely with the Engineering IT.
Bio Scientific International
Worked as an intern at Bio Scientific International, located in Shanghai, China. The company is a leading distributor in China for biotechnology devices from around the world. I worked in the services sector to help the current engineers calibrate and set up some of the instruments. I also editted their brochures, pampletes etc.
Dining Services BU
Worked as a food server at Boston University's Dining Hall for a semester. I always wanted to experience the food industry because I conside myself a big foodie.


School sports information
This page will contain forthcoming events,
results, and match write-ups.
P.E. Club Nights
| Day | Girls | Boys |
| Monday | Netball: All | Rugby: All |
| Tuesday | Academic Tutoring | Academic Tutoring |
| Wednesday | Dance: Y7&8 |
Basketball: U15/U16ís
Dance: Y7&8 Hockey: All |
| Thursday |
Hockey: All
Basketball: All Gymnastics: All |
Basketball: U14ís
Gymnastics: All |
| Friday | Volleyball: Y9-11 | Volleyball: Y9-11 |


Dynamic Tables METRO STYLE ADMIN PANEL
Default table sorting
| Name | Product | Status | Date | Actions | |
|---|---|---|---|---|---|
| Dmitry Ivaniuk | Product #212 | New | 24/11/2012 |
|
|
| John Doe | Product #132 | New | 24/11/2012 |
|
|
| Alex Fruz | Product #53 | New | 23/11/2012 |
|
|
| Olga Yukhimchuk | Product #874 | Pending | 23/11/2012 |
|
|
| Angelina Rose | Product #533 | Pending | 23/11/2012 |
|
Table sorting
| Name | Product | Status | Date | Actions | |
|---|---|---|---|---|---|
| Dmitry Ivaniuk | Product #212 | New | 24/11/2012 |
|
|
| John Doe | Product #132 | New | 24/11/2012 |
|
|
| Alex Fruz | Product #53 | New | 23/11/2012 |
|
|
| Olga Yukhimchuk | Product #874 | Pending | 23/11/2012 |
|
|
| Angelina Rose | Product #533 | Pending | 23/11/2012 |
|
|
| Alexandra Belova | Product #898 | Delivered | 21/11/2012 |
|
|
| Ivanov Ivan | Product #900 | Delivered | 21/11/2012 |
|
|
| Eugune Noise | Product #231 | Delivered | 20/11/2012 |
|
|
| Anatoly Yukhim | Product #874 | Delivered | 20/11/2012 |
|
|
| Vasily Ivaniuk | Product #355 | Delivered | 19/11/2012 |
|
Table sorting pagination
| Name | Product | Status | Date | Actions | |
|---|---|---|---|---|---|
| Dmitry Ivaniuk | Product #212 | New | 24/11/2012 |
|
|
| John Doe | Product #132 | New | 24/11/2012 |
|
|
| Alex Fruz | Product #53 | New | 23/11/2012 |
|
|
| Olga Yukhimchuk | Product #874 | Pending | 23/11/2012 |
|
|
| Angelina Rose | Product #533 | Pending | 23/11/2012 |
|
|
| Alexandra Belova | Product #898 | Delivered | 21/11/2012 |
|
|
| Ivanov Ivan | Product #900 | Delivered | 21/11/2012 |
|
|
| Eugune Noise | Product #231 | Delivered | 20/11/2012 |
|
|
| Anatoly Yukhim | Product #874 | Delivered | 20/11/2012 |
|
|
| Vasily Ivaniuk | Product #355 | Delivered | 19/11/2012 |
|
AJAX Data load
| Rendering engine | Browser | Platform(s) | Engine version | CSS grade |
|---|


Retrieves the DateTime info from database server. This method may needs some privilege according to the database product and its version. Examples Following section retrieves DateTime info from database server. using(var exc = cn.Executer()) Console.WriteLine("DateTime = " + exc.GetServerDateTime()); DateTime = 12/25/2020 8:09:06 AM jJ0DZ7
using(var exc = cn.Executer()) Console.WriteLine("DateTime = " + exc.GetServerDateTime());


New UI layout,
Dropped support for Tiger,
Updated for Snow Leopard
- [REMOVE] Dropped support for Tiger.
- [ADD] Added support for Snow Leopard. Build now also includes 64-bit architecture.
- [ADD] Added Russion translation. Thanks to Максим Буринов
- [CHANGE] Changed the UI layout to be a more Mac-like. Thanks to Philipp Mayerhofer.


--- layout: post title: 'LIFT07: Literacy, Communication and Design, Jan Chipchase' date: 2007-02-08 00:00:00 categories: interfaces-&-interaction mobile ---
LIFT07: Literacy, Communication and Design, Jan Chipchase
Works for Nokia Design in Tokyo. The task: "design a phone for illiterate people".
Shows up the UN definition of literacy. The core function of a phone is to transcend space and time: crossing great distances and enabling asynchronous communication, in a personal and convenient manner.
It's better to solve the root causes of a problem than design around it.
Is there a point in our evolution where textual literacy becomes redundant?
799 million illiterate people on the planet, 270m of them in India but illiteracy is everywhere. Lots of folks use devices that don't support their native language.
Phones designed in Helsinki increasingly get used in markets where there's much less structured (in-school) learning, like Brazil, India, etc. But there's also unstructured learning: visual observation, aural, tactile stuff. When most people talk about literacy they mean textual literacy. There also proximate literacy - using the literacy of those around you.
Most people propose an iconic interface to solve the problem. But icons are just another language. Icons need to be learned, are difficult to learn without support from text prompts, and need to vary across markets. They can be part of the solution, but don't solve the problem.
To what extent is textual literacy a barrier?
Nokia did 3-4 years of research in India, China, Nepal, etc.: home visits, interviews, shadowing, observation. Looking at where text prompts were barriers. How do illiterate people use TV? How do they tell the time? Use mechanical objects? Illiterate people have textual objects in the home, like calendars: how do they work with them?
Tasks involving time and contact management: how do you manage your contacts if illiterate? Know you're being paid enough? Millions of people do this daily.
What did we learn?
Illiterate people work long hours. 5-9, 7 days a week. These guys need to transcend time and space more than the rest of us. Literate tasks require assistance and more time. It involves giving up a lot of privacy. It's all possible, just not practical.
They can operate handsets, make local calls, answer calls. Barriers are national calls, editing, management. They tend to carry physical contact books.
Risks and consequences: how much trial and error can illiterate users do? There is a cost to expecting users to explore (poor mental models, risk of changing settings and altering phone).
Context helps us make decisions. How much contextual info can be provided on a phone interface?
What tasks can we delegate to others, to technology. The illiterate are like the very rich in that they have support for communication tasks: from a task-process design POV it's very similar.
Illiterate users are like us, only more so.
Q: What did it look like (the resulting phone)?
A: The interface looks like the current handset experience, but with lots of small incremental experience. Can't show you the product.
Q: What's your take on the Motophone? Is this the easy path?
A: It's a simplified device. I can't judge it. First product actively marketed as being appealing to illiterate people.... there's a social stigma here, will they go for it?
I must download this presentation and make everyone@FP read it.


:: com :: sun :: star :: sheet ::
|
| deprecated |
interface XSheetPastable |
|
|
|
- Usage Restrictions
- deprecated
- Description
- represents a sheet into which contents of the clipboard can be pasted.
|
| Methods' Summary |
| paste |
pastes the contents of the clipboard at the specified
position on the sheet.
|
| pasteFormat |
pastes the contents of the clipboard at the
specified position on the sheet, using the specified format.
|
| pasteCellRange |
pastes clipboard data from a cell range into
another cell range.
|
| Methods' Details |
paste
- Description
- pastes the contents of the clipboard at the specified
position on the sheet.
|
|
pasteFormat
| void |
| pasteFormat( |
[in] ::com::sun::star::table::CellAddress |
aDestination, |
| [in] string |
aFormat ); |
- Description
- pastes the contents of the clipboard at the
specified position on the sheet, using the specified format.
|
|
pasteCellRange
- Description
- pastes clipboard data from a cell range into
another cell range.
The contents of the clipboard must be from a cell range.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.


Ping-Pong
Creator
Cody Brubaker
Let's Play
Rules:
Ping Pong will count up to your number from 1 with the following exceptions:
Numbers divisible by 3 become "ping"
Numbers divisible by 5 become "pong"
Numbers divisible by 3 and 5 or 15 becomes "ping-pong"
Enter your number here:
Submit


Stage O: Gettig Started with HTML
5 Ways to think like a programmer
- Procedural Thinking
- Big Problem turned into logical steps
- Abstract Thinking
- Symbols may have numerical values
- Numbers may have symbolic meaning
- Systematic Debugging
- Identify the problem
- Trackdown possible causes
- Technological Empathy
- Understanding how computers send things
- Systems Thinking
- One big item broken into component parts
Debugging Methodology
- Collect evidence
- Generate theories
- Test those theories
- Fix the problem
- Rinse and repeat
What is the World Wide Web (www) made up of?
- Invented in the 1990's
- Created with HTMLcoding
- HTML = HyperTextMarkupLanguage
- Hyperlinks which glue the docments together
- Consists of over 30 billion pages
What are Tags and Elements?
- Opening Tags are contained within brackets “<__>”
- Closing Tags are duplicates of the opening tag, but preceded by a forward slash “<”/”__>”
- An element is the entire opening tag, contents and closing tag
- Attributes are content properties of HTML elements
Why are computers stupid?
- Computers only think via linear concepts
- If all lines are coded correctly, but the syntax is wrong errors and debugging will follow
Programmers have the greatest helpdesk available to them in the Internet
- Humans are likely to forget some of the things they once learned
- To learn to use previously unknown Tags one need only query the Internet
- I learned how to use ordered and unordered lists for this exercise
HTML Tag Library
- Inline Tags
- Block Tags
- ordered list
- paragraph
- unordered list


TABLE OF INTERACTIONS WITH
LITHIUM
See also: medications at the origin of a serotonin syndrome
From the French ANSM drug interactions document of
September 2016, pp. 143-144
LITHIUM RxNorm: 6448 ATC: D11AX04 |
ACETAZOLAMIDE RxNorm: 167 ATC: S01EC01 |
Decrease of the plasma concentrations of lithium with risk of reduction of the therapeutic effectiveness |
Precautions for use Strict monitoring of the the plasma concentrations of lithium and possible adjustment of the dosage of lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
ANGIOTENSIN II RECEPTOR ANTAGONISTS or ANGIOTENSIN RECEPTOR BLOCKERS (ARBs) CLASS CODE: C09CA0-001 |
Increase of the the plasma concentrations of lithium that can attain toxic values (decrease of the renal excretion of the lithium) . |
Not recommended If the use of the angiotensin II antagonist is indispensable, strict monitoring of the the plasma concentrations of lithium and adjustment of the dosage |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
NON STEROIDAL ANTI-INFLAMMATORY DRUGS CLASS CODE: M01A-002 |
Increase of the the plasma concentrations of lithium that can reach toxic values (decrease of the renal excretion of the lithium) |
Not recommended If administering the substances together cannot be avoided, monitor the the plasma concentrations of lithium closely and adjust the dosage of the lithium during the administration of the substances together and after the NSAI is stopped. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
CAFFEINE RxNorm: 1886 ATC: N06BC01 V04CG30 |
In case of sudden discontinuation of consumption of coffee or of medications containing caffeine, risk of increase of the the plasma concentrations of lithium |
Take into account |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
CALCITONIN RxNorm: 36118 ATC: H05BA H05BA03 H05BA02 H05BA01 H05BA01 |
Risk of reduction of the effectiveness of the lithium due to increase of its renal elimination by the calcitonin |
Precaution for use Regular clinical and biological monitoring, especially at the beginning of the administration of the substances together. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
CARBAMAZEPINE RxNorm: 2002 ATC: N03AF01 |
Risk of neurotoxicity manifesting as disorders of the cerebellum, confusion, drowsiness, ataxia. These disorders are reversible when the treatment with lithium is stopped |
Not recommended |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
LOOP DIURETICS CLASS CODE: C03CA-001 |
Increase of the the plasma concentrations of lithium with signs of overdose of lithium as with a low sodium regimen (decrease of the urinary excretion of the lithium) |
Not recommended If administering these substances together cannot be avoided, strict monitoring of the the plasma concentrations of lithium and adjustment of the dosage of lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
POTASSIUM SPARING DIURETICS (ALONE OR IN COMBINATION) CLASS CODE: C0E-004 |
Increase of the the plasma concentrations of lithium with signs of overdose of lithium, as with a low sodium regimen (decrease of the urinary excretion of the lithium) |
Precaution for use Strict monitoring of the the plasma concentrations of lithium and possible adjustment of the dosage of the lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
THIAZIDE DIURETICS AND RELATED CLASS CODE: C03-003 |
Increase of the the plasma concentrations of lithium with signs of overdose of lithium, as with a low sodium regimen (decrease of the urinary excretion of the lithium) |
Not recommended If administering the substances together cannot be avoided, strict monitoring of the the plasma concentrations of lithium and adjustment of the dosage of the lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
GLYCEROL RxNorm: 4910 ATC: A06AG04 A06AX01 A16AX09 |
Decrease of the the plasma concentrations of lithium with risk of reduction of the therapeutic effectiveness |
Precaution for use Strict monitoring of the the plasma concentrations of lithium and possible adjustment of the dosage of lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
ANGIOTENSIN CONVERTING ENZYME INHIBITORS (ACE INHIBITORS) CLASS CODE: C09AA |
Increase of the the plasma concentrations of lithium which can reach toxic values (decrease of the renal excretion of the lithium) |
Not recommended If the use of an ACE inhibitor is indispensable, strict monitoring of the the plasma concentrations of lithium and adjustment of the dosage of the lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
SELECTIVE SEROTONIN REUPTAKE INHIBITORS (SSRIs) CLASS CODE: N06AB |
Risk of appearance of a serotonin syndrome |
Precaution for use Regular clinical and biological monitoring, especially at the beginning of the administration of these substances together. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
MANNITOL RxNorm: 6628 ATC: A06AD16 B05BC01 B05CX04 R05CB16 |
Decrease of the the plasma concentrations of lithium with risk of reduction of the therapeutic effectiveness |
Precaution for use Strict monitoring of the the plasma concentrations of lithium and possible adjustment of the dosage of lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
METHYLDOPA RxNorm: 6876 ATC: C02AB C02LB C02AB01 C02LB01 C02AB02 |
Increase of the the plasma concentrations of lithium which can attain toxic values, with signs of overdose of lithium |
Precaution for use Clinical monitoring and adjustment of the dosage of lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
METRONIDAZOLE RxNorm: 6922 ATC: A02BD08 A02BD03 A02BD02 A01AB17 D06BX01 G01AF01 J01XD01 P01AB01 A02BD01 |
Increase of the the plasma concentrations of lithium which can attain toxic values with signs of overdose of lithium. |
Precaution for use Strict monitoring of the the plasma concentrations of lithium and possible adjustment of the dosage of the lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
NEUROLEPTICS CLASS CODE: N05AA-003 |
Risk of appearance of neuropsychic signs evocative of a neuroleptic malignant syndrome or of lithium poisoning |
Precaution for use Regular clinical amd biological monitoring, especially at the beginning of the administration of the substances together. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
ORLISTAT RxNorm: 37925 ATC: A08AB01 |
Risk of therapeutic failure when there is concomitant treatment with orlistat |
Take into account |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
SODIUM BICARBONATE RxNorm:36676 ATC: A02AH B05CB04 B05XA02 |
Risk of reduction of the effectiveness of the lithium due to increase of its renal elimination by the sodium salts |
Precaution for use Avoid excessive sodium and take account of the presence of sodium in certain medications such as antacids. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
SODIUM CHLORIDE RxNorm: 9863 ATC: A12CA01 B05CB01 B05XA03 |
Risk of reduction of the effectiveness of the lithium due to increase of its renal elimination by the sodium salts. |
Precaution for use Avoid excessive sodium and take account of the presence of sodium in certain medications such as antacids. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
THEOPHYLLINE RxNorm: 10438 ATC: R03DA04 |
Decrease of the the plasma concentrations of lithium with risk of reduction of the therapeutic effectiveness |
Precaution for use Strict monitoring of the lithemia and possible adjustment of the dosage of the the plasma concentrations of lithium. |
LITHIUM RxNorm: 6448 ATC: D11AX04 |
TOPIRAMATE RxNorm: 38404 ATC: 38404 |
For doses of topiramate >= 200 mg/day: increase of the the plasma concentrations of lithium that can reach toxic values, with signs of overdose of lithium. |
Precaution for use Clinical and biological monitoring. Adjustment of the dosage of the lithium. |


Visualization
learning_curves¶
ludwig.visualize.learning_curves( train_stats_per_model, field, model_names=None, output_directory=None, file_format='pdf' )
Show how model measures change over training and validation data epochs.
For each model and for each output feature and measure of the model, it produces a line plot showing how that measure changed over the course of the epochs of training on the training and validation sets. :param train_stats_per_model: List containing train statistics per model :param field: Prediction field containing ground truth. :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
compare_performance¶
ludwig.visualize.compare_performance( test_stats_per_model, field, model_names=None, output_directory=None, file_format='pdf' )
Produces model comparision barplot visualization for each overall metric
For each model (in the aligned lists of test_statistics and model_names) it produces bars in a bar plot, one for each overall metric available in the test_statistics file for the specified field. :param test_stats_per_model: List containing train statistics per model :param field: Prediction field containing ground truth. :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
compare_classifiers_performance_from_prob¶
ludwig.visualize.compare_classifiers_performance_from_prob( probabilities_per_model, ground_truth, top_n_classes, labels_limit, model_names=None, output_directory=None, file_format='pdf' )
Produces model comparision barplot visualization from probabilities.
For each model it produces bars in a bar plot, one for each overall metric computed on the fly from the probabilities of predictions for the specified field. :param probabilities_per_model: List of model probabilities :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata :param top_n_classes: List containing the number of classes to plot :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
compare_classifiers_performance_from_pred¶
ludwig.visualize.compare_classifiers_performance_from_pred( predictions_per_model, ground_truth, metadata, field, labels_limit, model_names=None, output_directory=None, file_format='pdf' )
Produces model comparision barplot visualization from predictions.
For each model it produces bars in a bar plot, one for each overall metric computed on the fly from the predictions for the specified field. :param predictions_per_model: List containing the model predictions for the specified field :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata :param metadata: Model's input metadata :param field: field containing ground truth :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
compare_classifiers_performance_subset¶
ludwig.visualize.compare_classifiers_performance_subset( probabilities_per_model, ground_truth, top_n_classes, labels_limit, subset, model_names=None, output_directory=None, file_format='pdf' )
Produces model comparision barplot visualization from train subset.
For each model it produces bars in a bar plot, one for each overall metric computed on the fly from the probabilities predictions for the specified field, considering only a subset of the full training set. The way the subset is obtained is using the top_n_classes and subset parameters. :param probabilities_per_model: List of model probabilities :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata :param top_n_classes: List containing the number of classes to plot :param labels_limit: Maximum numbers of labels. :param subset: Type of the subset filtering :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
compare_classifiers_performance_changing_k¶
ludwig.visualize.compare_classifiers_performance_changing_k( probabilities_per_model, ground_truth, top_k, labels_limit, model_names=None, output_directory=None, file_format='pdf' )
Produce lineplot that show Hits@K measure while k goes from 1 to top_k.
For each model it produces a line plot that shows the Hits@K measure (that counts a prediction as correct if the model produces it among the first k) while changing k from 1 to top_k for the specified field. :param probabilities_per_model: List of model probabilities :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata param top_k: Number of elements in the ranklist to consider :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
compare_classifiers_multiclass_multimetric¶
ludwig.visualize.compare_classifiers_multiclass_multimetric( test_stats_per_model, metadata, field, top_n_classes, model_names=None, output_directory=None, file_format='pdf' )
Show the precision, recall and F1 of the model for the specified field.
For each model it produces four plots that show the precision, recall and F1 of the model on several classes for the specified field. :param test_stats_per_model: List containing train statistics per model :param metadata: Model's input metadata :param field: Prediction field containing ground truth. :param top_n_classes: List containing the number of classes to plot :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None: :return:
compare_classifiers_predictions¶
ludwig.visualize.compare_classifiers_predictions( predictions_per_model, ground_truth, labels_limit, model_names=None, output_directory=None, file_format='pdf' )
Show two models comparision of their field predictions.
:param predictions_per_model: List containing the model predictions :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
confidence_thresholding_2thresholds_2d¶
ludwig.visualize.confidence_thresholding_2thresholds_2d( probabilities_per_model, ground_truths, threshold_fields, labels_limit, model_names=None, output_directory=None, file_format='pdf' )
Show confidence trethreshold data vs accuracy for two field thresholds
The first plot shows several semi transparent lines. They summarize the 3d surfaces displayed by confidence_thresholding_2thresholds_3d that have thresholds on the confidence of the predictions of the two threshold_fields as x and y axes and either the data coverage percentage or the accuracy as z axis. Each line represents a slice of the data coverage surface projected onto the accuracy surface. :param probabilities_per_model: List of model probabilities :param ground_truths: List of NumPy Arrays containing computed model ground truth data for target prediction fields based on the model metadata :param threshold_fields: List of fields for 2d threshold :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param model_names: Name of the model to use as label. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
confidence_thresholding_2thresholds_3d¶
ludwig.visualize.confidence_thresholding_2thresholds_3d( probabilities_per_model, ground_truths, threshold_fields, labels_limit, output_directory=None, file_format='pdf' )
Show 3d confidence trethreshold data vs accuracy for two field thresholds
The plot shows the 3d surfaces displayed by confidence_thresholding_2thresholds_3d that have thresholds on the confidence of the predictions of the two threshold_fields as x and y axes and either the data coverage percentage or the accuracy as z axis. :param probabilities_per_model: List of model probabilities :param ground_truths: List of NumPy Arrays containing computed model ground truth data for target prediction fields based on the model metadata :param threshold_fields: List of fields for 2d threshold :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
confidence_thresholding¶
ludwig.visualize.confidence_thresholding( probabilities_per_model, ground_truth, labels_limit, model_names=None, output_directory=None, file_format='pdf' )
Show models accuracy and data coverage while increasing treshold
For each model it produces a pair of lines indicating the accuracy of the model and the data coverage while increasing a threshold (x axis) on the probabilities of predictions for the specified field. :param probabilities_per_model: List of model probabilities :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
confidence_thresholding_data_vs_acc¶
ludwig.visualize.confidence_thresholding_data_vs_acc( probabilities_per_model, ground_truth, labels_limit, model_names=None, output_directory=None, file_format='pdf' )
Show models comparision of confidence treshold data vs accuracy.
For each model it produces a line indicating the accuracy of the model and the data coverage while increasing a threshold on the probabilities of predictions for the specified field. The difference with confidence_thresholding is that it uses two axes instead of three, not visualizing the threshold and having coverage as x axis instead of the threshold. :param probabilities_per_model: List of model probabilities :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
confidence_thresholding_data_vs_acc_subset¶
ludwig.visualize.confidence_thresholding_data_vs_acc_subset( probabilities_per_model, ground_truth, top_n_classes, labels_limit, subset, model_names=None, output_directory=None, file_format='pdf' )
Show models comparision of confidence treshold data vs accuracy on a subset of data.
For each model it produces a line indicating the accuracy of the model and the data coverage while increasing a threshold on the probabilities of predictions for the specified field, considering only a subset of the full training set. The way the subset is obtained is using the top_n_classes and subset parameters. The difference with confidence_thresholding is that it uses two axes instead of three, not visualizing the threshold and having coverage as x axis instead of the threshold.
If the values of subset is ground_truth, then only datapoints where the ground truth class is within the top n most frequent ones will be considered as test set, and the percentage of datapoints that have been kept from the original set will be displayed. If the values of subset is predictions, then only datapoints where the the model predicts a class that is within the top n most frequent ones will be considered as test set, and the percentage of datapoints that have been kept from the original set will be displayed for each model. :param probabilities_per_model: List of model probabilities :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata :param top_n_classes: List containing the number of classes to plot :param labels_limit: Maximum numbers of labels. :param subset: Type of the subset filtering :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
binary_threshold_vs_metric¶
ludwig.visualize.binary_threshold_vs_metric( probabilities_per_model, ground_truth, metrics, positive_label=1, model_names=None, output_directory=None, file_format='pdf' )
Show confidence of the model against metric for the specified field.
For each metric specified in metrics (options are f1, precision, recall, accuracy), this visualization produces a line chart plotting a threshold on the confidence of the model against the metric for the specified field. If field is a category feature, positive_label indicates which is the class to be considered positive class and all the others will be considered negative. It needs to be an integer, to figure out the association between classes and integers check the ground_truth_metadata JSON file. :param probabilities_per_model: List of model probabilities :param ground_truth: List of NumPy Arrays containing computed model ground truth data for target prediction fields based on the model metadata :param metrics: metrics to dispay (f1, precision, recall, accuracy) :param positive_label: Label of the positive class :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
roc_curves¶
ludwig.visualize.roc_curves( probabilities_per_model, ground_truth, positive_label=1, model_names=None, output_directory=None, file_format='pdf' )
Show the roc curves for the specified models output field.
This visualization produces a line chart plotting the roc curves for the specified field. If field is a category feature, positive_label indicates which is the class to be considered positive class and all the others will be considered negative. It needs to be an integer, to figure out the association between classes and integers check the ground_truth_metadata JSON file. :param probabilities_per_model: List of model probabilities :param ground_truth: List of NumPy Arrays containing computed model ground truth data for target prediction fields based on the model metadata :param positive_label: Label of the positive class :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
roc_curves_from_test_statistics¶
ludwig.visualize.roc_curves_from_test_statistics( test_stats_per_model, field, model_names=None, output_directory=None, file_format='pdf' )
Show the roc curves for the specified models output binary field.
This visualization uses the field, test_statistics and model_names parameters. field needs to be binary feature. This visualization produces a line chart plotting the roc curves for the specified field. :param test_stats_per_model: List containing train statistics per model :param field: Prediction field containing ground truth. :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
calibration_1_vs_all¶
ludwig.visualize.calibration_1_vs_all( probabilities_per_model, ground_truth, top_n_classes, labels_limit, model_names=None, output_directory=None, file_format='pdf' )
Show models probability of predictions for the specified field.
For each class or each of the k most frequent classes if top_k is specified, it produces two plots computed on the fly from the probabilities of predictions for the specified field.
The first plot is a calibration curve that shows the calibration of the predictions considering the current class to be the true one and all others to be a false one, drawing one line for each model (in the aligned lists of probabilities and model_names).
The second plot shows the distributions of the predictions considering the current class to be the true one and all others to be a false one, drawing the distribution for each model (in the aligned lists of probabilities and model_names). :param probabilities_per_model: List of model probabilities :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata :param top_n_classes: List containing the number of classes to plot :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
calibration_multiclass¶
ludwig.visualize.calibration_multiclass( probabilities_per_model, ground_truth, labels_limit, model_names=None, output_directory=None, file_format='pdf' )
Show models probability of predictions for each class of the the specified field.
:param probabilities_per_model: List of model probabilities :param ground_truth: NumPy Array containing computed model ground truth data for target prediction field based on the model metadata :param labels_limit: Maximum numbers of labels. If labels in dataset are higher than this number, "rare" label :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None:
confusion_matrix¶
ludwig.visualize.confusion_matrix( test_stats_per_model, metadata, field, top_n_classes, normalize, model_names=None, output_directory=None, file_format='pdf' )
Show confision matrix in the models predictions for each field.
For each model (in the aligned lists of test_statistics and model_names) it produces a heatmap of the confusion matrix in the predictions for each field that has a confusion matrix in test_statistics. The value of top_n_classes limits the heatmap to the n most frequent classes. :param test_stats_per_model: List containing train statistics per model :param metadata: Model's input metadata :param field: Prediction field containing ground truth. :param top_n_classes: List containing the number of classes to plot :param normalize: Flag to normalize rows in confusion matrix :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None: :return:
frequency_vs_f1¶
ludwig.visualize.frequency_vs_f1( test_stats_per_model, metadata, field, top_n_classes, model_names=None, output_directory=None, file_format='pdf' )
Show prediction statistics for the specified field for each model.
For each model (in the aligned lists of test_statistics and model_names), produces two plots statistics of predictions for the specified field.
The first plot is a line plot with one x axis representing the different classes and two vertical axes colored in orange and blue respectively. The orange one is the frequency of the class and an orange line is plotted to show the trend. The blue one is the F1 score for that class and a blue line is plotted to show the trend. The classes on the x axis are sorted by f1 score. The second plot has the same structure of the first one, but the axes are flipped and the classes on the x axis are sorted by frequency. :param test_stats_per_model: List containing train statistics per model :param metadata: Model's input metadata :param field: Prediction field containing ground truth. :param top_n_classes: List containing the number of classes to plot :param model_names: List of the names of the models to use as labels. :param output_directory: Directory where to save plots. If not specified, plots will be displayed in a window :param file_format: File format of output plots - pdf or png :return None: :return: