- Developper API  2.0.5
Data Structures
Here are the data structures with brief descriptions:
AbstractDataObjectObject that implements methods to read through SimpleXMLElement
DataObjectFactoryThe DataObjectFactory is probably the most important class of the API. It's the main place AbstractDataObject such as Wine, Winery, Range and Owner are created. All the developper must provide is either an id or vincod and the language (ex: en,fr,de...)
DataStructureData structure that contains a name, a type and a url. Those objects are usually embedded inside Wine object
LockableWhen an object implements Lockable it may be unmutable. The developper must ensure the unmutability of the object whenever lock is called. Static method are implemented on the final class Lockables (to send LockException for instance). This has been used during developement but is not anymore. However it might be useful for some case to have unmutable object to ensure data integrity
LockablesCollection of methods that can be used with objects that implements Lockable
MediaKind of DataStructure. Those objects are usually embedded inside Wine object
OwnerAn Owner is an AbstractDataObject. It contains all information about a single owner. Mostly made up of properties, it s also possible to get other AbstractDataObject (Wine, Winery, Range) concerning the Owner
PropertyA Property is a data structure that is made up of:
RangeA Range is an AbstractDataObject. It contains all information about a single range. Mostly made up of properties, it s also possible to get other AbstractDataObject (Wine, Winery, Owner) concerning the Range
RecipeKind of DataStructure with a video attribute. Those objects are usually embedded inside Wine object
ReviewThe Review is a data structure that embed information about a review (author, source content...). Those objects are usually embedded inside Wine object
ShopKind of DataStructure with a description. A shop always has the type equals to shop. Those objects are usually embedded inside Wine object
VarietyData structure that contains information about variety of grape (or "cepage" in french). Those objects are usually embedded inside Wine object
VintagePropertyData structure that contains Vintage information. Those objects are usually embedded inside Wine object
WEObjectData structure that contains WineEverybody's information. Those objects are usually embedded inside Wine object
WineA Wine is an AbstractDataObject. It contains all information about a single wine. Mostly made up of properties and DataStructure objects (Media, Shop, Recipe) and others such as Review, Variety, VintageProperty and WEObject. It s also possible to get other AbstractDataObject (Owner, Winery, Range) concerning the Wine
WineryA Winery is an AbstractDataObject. It contains all information about a single winery. Mostly made up of properties, it s also possible to get other AbstractDataObject (Wine, Owner, Range) concerning the Winery