AttMagic

Object
- AttMagic

All Implemented Interfaces:: Externalizable, Serializable, RemoteAccess

public class AttMagic
extends Object
implements RemoteAccess, Externalizable

code examples:

 
 // find ibas of type: String typeName = "DefaultEPMDocument" // without prefix crap! AttMagic.T t = AttMagic.getT(typeName); if (t == null) throw new IEException("type \"" + typeName + "\" not found."); Map<String, AttMagic.A> atts = t.getAttsInfo()[AttMagic.GLOBAL]; AttMagic.A a; for (String attName : atts.keySet()) { a = atts.get(attName); System.err.println("att " + attName + " is stored in " + a.getDbCol() + " type " + a.getDataType()); }

purpose:

handle all attribute related api tasks for new types, providing a simple interface (Map with attribute name/value pairs).
it does not handle any ootb (modeled) attributes, though a custom subclass could implement this.

features:

Note: most functionality is available via commandline, call AttMagic without arguments for help.

retrieve customer added attributes as strings or raw values
check if a given map has modified values compared to the attribute holder
update the attributes of a holder, optionally low-level without checkout
multi value global attributes: if the value of a key is a List, Set or Object[], multivalue set/add is performed.
if update is not forced (update-objects) then constraints are checked and an error will occur if the attribute is defined as single-valued
if forced update is performed, standard attributes are set to the result of ToolUtils.nn(value), and values for type URL may contain description->URL

Enumeration
information
constants:

key:	value:
AttMagic.ENUM_ENTRY_NAME	internal name
AttMagic.ENUM_ENTRY_DISPLAY	default display value
AttMagic.ENUM_ENTRY_ACTIVE	true/false
AttMagic.ENUM_ENTRY_SORT	sort oder (or empty if not defined)
en_US	english display
more locales ...	translated displays ...
AttMagic.ENUM_DESC_PREFIX +AttMagic.ENUM_ENTRY_DESC	default description
AttMagic.ENUM_DESC_PREFIX +"en_US"	locale specific description
AttMagic.ENUM_DESC_PREFIX +".."	more locale specific descriptions

TODO:

explain enum mapping.

restrictions:

right now this class only deals with additional attributes, no ootb modeled atts are dealt with. composed/alias atts will be read on explicit request.

examples:

 
 find global atts (IBAS) defined for DefaultEPMDocument:
 
 String typeName="DefaultEPMDocument"; // without prefix crap! AttMagic.T t = AttMagic.getT(typeName); if (t == null) throw new WTException("type \"" + typeName + "\" not found."); Map atts = t.getAttsInfo()[AttMagic.GLOBAL]; AttMagic.A a; for (String attName:atts.keySet()){ a=atts.get(attName); System.err.println("att "+attName+" is stored in "+a.getDbCol()+" type "+a.getDataType()); }

Author:: mkraegeloh
See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AttMagic.A` represents a LWCxxxAttDefinition
`static class`	`AttMagic.S`
`static class`	`AttMagic.T` T represents a LWCTypeDefinition

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIAS`
`static int`	`CALCULATED`
`static SimpleDateFormat`	`DATE_WITH_TIME` default date/time format: yyyyMMdd HH:mm:ss
`static String`	`DECODE_DESCRIPTION`
`static String`	`DESCRIPTION_URL_DELIMITER`
`static Object`	`EDIT_IBAS`
`static String`	`ENUM_DESC_PREFIX`
`static String`	`ENUM_ENTRY_ACTIVE`
`static String`	`ENUM_ENTRY_DESC`
`static String`	`ENUM_ENTRY_DISPLAY`
`static String`	`ENUM_ENTRY_KEY`
`static String`	`ENUM_ENTRY_NAME`
`static String`	`ENUM_ENTRY_SORT`
`static FastDateFormat`	`FORMATTERT`
`static int`	`GLOBAL`
`static String`	`LOCK`
`static int`	`MAJOR`
`static int`	`MAP_SIZE`
`static int`	`MINOR`
`static int`	`MODELED`
`static int`	`MULTIVAL_ANY` return last (randomly) encountered value if multi value IBA detected
`static int`	`MULTIVAL_ERR` throw Exception if multi value IBA detected
`static int`	`MULTIVAL_LIST` if multi value IBA found, return values in List
`static int`	`MULTIVAL_SET` if multi value IBA found, return values in a Set
`static String`	`PRECISIONS`
`static String`	`RAW_ATTS`
`static int`	`STANDARD`

Fields inherited from interface RemoteAccess
versionID

Constructor Summary

Constructors
Constructor and Description
`AttMagic()` simple constructor if data map and object to update are set later
`AttMagic(AttMagic template)` initialize Attmagic from a template object (create a static one, set desired flag, from this construct new ones)
`AttMagic(Object attHolder)` create AttMagic object for a persistable.
`AttMagic(Object attHolder, AttMagic template)` create AttMagic object for a persistable from a template AttMagic objects (thus allowing to preserve settings)

Method Summary

Methods
Modifier and Type	Method and Description
`static Object`	`_main(Class mec, String[] args)` to invoke main in MS
`void`	`custPostRead(Persistable obid)` subclass can implement custom logic here
`void`	`custPostWrite(Persistable obid)` subclass can implement custom logic here
`void`	`custPreRead(Persistable obid)` subclass can implement custom logic here
`void`	`custPreWrite(Persistable attHolder2)` subclass can implement custom logic here
`void`	`custTypeChanged(Persistable obid)` subclass can implement custom logic here
`static String`	`decode(String in)` decode the encoded internal enum value into the real internal value - as returned by AttMagic getAtts
`static String`	`encode(String in)` encode a string for use as internal enum value: if it contains only acceptable values (in old 10 versions it could contain digits but not start with one) it is prefixed with 'x', else prefix is 'y' and the interal value is base64 encoded
`static List<AttMagic.A>`	`findAtt(String attRe)` deliver info about atts in type[s] passing a regex against the att name
`static List<AttMagic.A>`	`findAtt(String typeName, String attRe)` deliver info about atts in type[s] passing a regex against the att name
`static List<Persistable>`	`findObjects(String type, Map<String,String> where)` find objects of given type with criteria passed in a Map (where key=value ...)
`Persistable`	`forceAtts()` forcefully update atts - no checkout.
`static void`	`forcedCopyStdAtts(Object from, Object to)` copy the standard attributes of one object to another - just sets the typeinfo object of the old to the new holder.
`Object`	`getAtt(String name)` return the value for attribute by name
`static AttMagic.A`	`getAtt(String type, String att)` deliver info about the attribute in the type
`Persistable`	`getAttHolder()` see setter method.
`static Map<String,String>`	`getAttributesNames(Object typed)` deliver a map of global and standard attributes for given typed obj
`Map<String,String>`	`getAtts()` return the holder's attributes as strings
`Map<String,String>`	`getAtts(Persistable from)` read the attributes of an object, hiding the storage (standard att versus global (iba)) - just returns a map<String,String>
`static Map<String,AttMagic.A>[]`	`getAttsInfo(Object typed)` deliver info about the type's attributes, grouped by attribute type
`static Map<String,AttMagic.A>[]`	`getAttsInfo(String type)` deliver info about the type's attributes, grouped by attribute type
`String`	`getCheckinMessage()` see setter method.
`String`	`getCheckoutMessage()` see setter method.
`FastDateFormat`	`getDateFormat()` see setter method.
`String`	`getDefaultForMissingAtts()` see setter method.
`static List<Map<String,String>>`	`getEntryMaps(String enumName)` return for the global enumeration enumName a Map indexed with the enumeration entry keys and a Map as value holding name, other info and locale specific data:
`static String`	`getEnumDescriptionValue(String enumName, String entryName)` return the default description value of an enumeration entry
`static String`	`getEnumDescriptionValue(String enumName, String entryName, Locale locale)` return the localized description value of an enumeration entry, tries language_country, language, default description
`static String`	`getEnumDescriptionValue(String enumName, String entryName, String[] locale)` return the first localized description value of an enumeration entry from the list passed in locale
`static String`	`getEnumDisplayValue(String enumName, String entryName)` return the default display value of an enumeration entry
`static String`	`getEnumDisplayValue(String enumName, String entryName, Locale locale)` return the localized display value of an enumeration entry, tries language_country, language, default display
`static String`	`getEnumDisplayValue(String enumName, String entryName, String[] locale)` return the first localized display value of an enumeration entry from the list passed in locale
`static Map<String,String>`	`getEnumEntryMap(String enumName, String entryName)` return infos about an entry in a global enum, @see getEntryMaps
`static boolean`	`getEnumValueSelectable(String enumName, String entryName)` tell if an enumeration entry is selectable
`static Map<String,Method>`	`getGetters(Class cls)` return a Map with ptcXXX key/Method values for a given class
`int`	`getMultiValBehavior()` see setter method.
`String`	`getNewTypeName()` see setter method.
`Map<String,Object>`	`getRawAtts()` return the holder's attributes as java objects. as a side effect populates the Map precisions with the precision value[s] of the real/unit values read from the database.
`Map<String,Object>`	`getRawAtts(Persistable from)` return the persistable's attributes as java objects. as a side effect populates the Map precisions with the precision value[s] of the real/unit values read from the database.
`Map<String,Object>`	`getRawAtts(Persistable from, boolean addPrecision)` return the persistable's attributes as java objects., optionally also retrieve the precisions to use after the call the proteced Map precisions with the precision value[s] of the real/unit values read from the database is populated.
`static List<String[]>`	`getSortedEnumDisplayValues(String enumName, boolean selOnly)` return the default display values of an enumeration
`static List<String[]>`	`getSortedEnumDisplayValues(String enumName, boolean selOnly, Locale locale)` return the localized display value of an enumeration entry, tries language_country, language, default display
`static List<String[]>`	`getSortedEnumDisplayValues(String enumName, boolean selOnly, String[] locale)` return the first localized display value of an enumeration entry from the list passed in locale
`static List<AttMagic.T>`	`getT()` return a List of all type info objects (T)
`static AttMagic.T`	`getT(String typeName)`
`String`	`getTypeName()` the attHolder's type.
`static Set<String>`	`getTypeNames()` return a list of all type names
`static Map<String,AttMagic.T>`	`getTypes()`
`boolean`	`hasDelta(Map<String,Object> toBe)` return true if holder's atts differ from the ones in the toBe Map.
`boolean`	`hasDelta(Map<String,Object> toBe, Set ignore)`
`static boolean`	`hasReadableAtt(Persistable typed, String att)` determines if typed objects type has a readable attribute with given name
`boolean`	`hasReadableAtt(String att)` determines if AttMagic's holder has a readable attribute with given name
`static boolean`	`hasReadableAtt(String type, String att)` determines if type has a readable attribute with given name
`static boolean`	`hasWriteableAtt(Persistable typed, String att)` determines if the typed object's type has a writable attribute with given name
`boolean`	`hasWriteableAtt(String att)` determines if AttMagic's holder has a writable attribute with given name
`static boolean`	`hasWriteableAtt(String type, String att)` determines if the type has a writable attribute with given name
`boolean`	`isAddAdhocIBAs()` see setter method.
`boolean`	`isAddAlias()` see setter method.
`boolean`	`isAddCalculated()` see setter method.
`boolean`	`isAddMasterAtts()` see setter method.
`boolean`	`isAddValues()` see setter method.
`boolean`	`isClearMissing()`
`boolean`	`isCreateEmpty()` see setter method.
`static boolean`	`isEnumEncoded(String enumName)` tell if enum has encoded internal values (must have the string AttMagic decode in it's description
`boolean`	`isForceCSM()` see setter method.
`boolean`	`isForcedUpdate()` see setter method.
`boolean`	`isForceFT()` see setter method.
`boolean`	`isIterate()` see setter method.
`boolean`	`isKeepCheckedOut()` see setter method.
`boolean`	`isMasterAttsOverride()` see setter method.
`boolean`	`isRefresh()` see setter method.
`boolean`	`isRemove()` see setter method.
`boolean`	`isUpdateToEmpty()` see setter method.
`boolean`	`isValidate()` see setter method.
`boolean`	`isWithMeta()` see setter method.
`boolean`	`isWithUnits()` see setter method.
`static void`	`main(String[] a)` print program usage info or invoke test cases
`Map<String,Object>`	`queryObject()` run query-objects against the internal object and return the Map with results for standard/global attributes, plus alias and/or calculated if requested by setup
`Map<String,Object>`	`queryObject(Object from)` run query-objects against object and return the Map with results for standard/global attributes, plus alias and/or calculated if requested by setup
`Map<String,Object>`	`queryObject(Object from, boolean onlyRO)` run query-objects against object and return the Map with results for standard/global attributes, plus alias and/or calculated if requested by setup
`Map<String,Object>`	`queryObject(Object from, boolean onlyRO, boolean addModeled)` run query-objects against object and return the Map with results for standard/global attributes, plus alias and/or calculated if requested by setup
`void`	`readExternal(ObjectInput objectinput)` deserialization.
`AttMagic`	`set(Map moreVals)` add key/values to data map (assumes keys are Strings!)
`AttMagic`	`set(String key, Object value)` add a key/value pair to the data Map - overrides existing key/values
`AttMagic`	`setAddAdhocIBAs(boolean addAdhocIBAs)` flag if AdHoc IBAs should be read/written (default = false)
`AttMagic`	`setAddAlias(boolean addAlias)` flag to tell if the result Map should also contain alias atts - default=false
`AttMagic`	`setAddCalculated(boolean addCalculated)` flag to tell if the result Map should also contain calculated atts - default=false
`AttMagic`	`setAddMasterAtts(boolean addMasterAtts)` flag if the attributes of the Master (if attHolder is RevisionControlled) should be added to result Map
`AttMagic`	`setAddValues(boolean addValues)` flag to make AttMagic add IBAs without deleting existing values (creates multivalue) default=false
`AttMagic`	`setAttHolder(Object attHolder)` set the Persistable to read/write atts from - can be an OBID or ObjectRef too.
`AttMagic`	`setCheckinMessage(String checkinMessage)` override default AttMagic checkin message
`AttMagic`	`setCheckoutMessage(String checkoutMessage)` override default AttMagic checkout message
`AttMagic`	`setClearMissing(boolean clear)` should AttMagic clear existing values not passed in map? default=false Note: this only works with forcedUpdate=true
`AttMagic`	`setCreateEmpty(boolean createEmpty)` should AttMagic create empty IBA values? default=false
`AttMagic`	`setData(Map<String,Object> values)` set a new data Map NOTE: AttMagic stores a copy of the Map, so first fill it, then call this method!
`AttMagic`	`setDateFormat(FastDateFormat dateFormat)` set new date format for date parsing
`AttMagic`	`setDateFormat(String dateFormat)` set new date format for date parsing
`AttMagic`	`setDefaultForMissingAtts(String defaultForMissingAtts)` if set this value will be put in the result map for missing attributes
`AttMagic`	`setForceCSM(boolean isCSM)` flag to set if classification nodes need to be written (default = false)
`AttMagic`	`setForcedUpdate(boolean forcedUpdate)` flag if update must happen without check-out - default=false
`AttMagic`	`setForcedUpdate(boolean forcedUpdate, boolean iterate)` flag if forced update must happen - if iterate=true run forced update on a newly created iteration (same as setForcedUpdate(true).setIterate(true) )
`AttMagic`	`setForceFT(boolean isFT)` flag to set if family table epmdocs need to be written (default = false)
`AttMagic`	`setIterate(boolean iterate)` flag to tell if the object should be iterated before forced update (=iterate but override constraints)
`AttMagic`	`setKeepCheckedOut(boolean keepCheckedOut)` flag to kepp the attHolder checked-out if AttMagic checked it out for update.
`AttMagic`	`setMasterAttsOverride(boolean masterAttsOverride)` if master adds are added to the map, should they override the iteration's values? default=false;
`AttMagic`	`setMultiValBehavior(int multiValBehavior)` configure what to do if multivalue IBA found: MULTIVAL_ERR throws an Exception MULTIVAL_ANY returns the last value seen MULTIVAL_LIST returns a List object with the values in it MULTIVAL_SET returns a Set with the values in it default=MULTIVAL_ERR.
`AttMagic`	`setNewTypeName(String newTypeName)` if set will re-type the attHolder to a different type.
`AttMagic`	`setQueryAtts(Set<String> attNamesSet)` set a new asked-for atts set NOTE: AttMagic stores a copy of the Set, so first fill it, then call this method!
`AttMagic`	`setRefresh(boolean noRefresh)` flag to tell if the attHolder is an IBAHolder, should it be refreshed before reading the IBAs? default=true
`AttMagic`	`setRemove(boolean remove)` flag if the written values should be removed from the (copied) map - set to false to call same AttMagic for more than one Object
`AttMagic`	`setType()` retype the holder with the newTypeName type
`AttMagic`	`setUpdateToEmpty(boolean updateToEmpty)` flag to tell update to an empty value should delete the xxxvalue (default=false, consistent with old/UpdateIBAs behaviour) if set to true will update existing iba values to empty rather than delete
`AttMagic`	`setValidate(boolean validate)` flag to force a constraint check even for forced update (not yet implemented) - default=false
`AttMagic`	`setWithMeta(boolean withMeta)` flag if atts returned must contain meta inforamtion about the atts themselves (not yet implemented)
`AttMagic`	`setWithUnits(boolean withUnits)` flag if the result of a float-with-unit should contain the unit too (default=true)
`static String`	`shortTypeName(Object typed)` returns the shortened type name (without the reversed internet domain)
`static Map`	`startup(Map in)` allows PremiumService to initialize AttMagic
`static String`	`TNWRID(String type)` return the type name with the reversed Site internet domain or java package, but without parent[s] info (wt.part.WTPart / WTPart)
`String`	`toString()` gets more verbose depending on log4j log level (DEBUG shows settings, TRACE shows initial data map)
`static Map`	`typeChanged(Map in)` allows PremiumService to notify AttMagic about type setup changes
`static String`	`typeName(Object typed)` returns the type name
`Persistable`	`update()` set the attHolder's attributes to the values in the internal new-values Map, hiding the storage (standard att versus global (iba))
`Persistable`	`update(Map<String,Object> values)` set the attHolder's attributes for the keys passed in the values Map, hiding the storage (standard att versus global (iba))
`void`	`updateIBAs(Map<String,Object> ibas)` update the IBAs of obj
`void`	`writeExternal(ObjectOutput objectoutput)` serialization

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAJOR
```
public static final int MAJOR
```
    See Also:
    Constant Field Values
  - MINOR
```
public static final int MINOR
```
    See Also:
    Constant Field Values
  - LOCK
```
public static final String LOCK
```
    See Also:
    Constant Field Values
  - EDIT_IBAS
```
public static final Object EDIT_IBAS
```
  - MULTIVAL_ERR
```
public static final int MULTIVAL_ERR
```
    throw Exception if multi value IBA detected
    
    See Also:
    Constant Field Values
  - MULTIVAL_ANY
```
public static final int MULTIVAL_ANY
```
    return last (randomly) encountered value if multi value IBA detected
    
    See Also:
    Constant Field Values
  - MULTIVAL_LIST
```
public static final int MULTIVAL_LIST
```
    if multi value IBA found, return values in List
    
    See Also:
    Constant Field Values
  - MULTIVAL_SET
```
public static final int MULTIVAL_SET
```
    if multi value IBA found, return values in a Set
    
    See Also:
    Constant Field Values
  - DATE_WITH_TIME
```
public static SimpleDateFormat DATE_WITH_TIME
```
    default date/time format: yyyyMMdd HH:mm:ss
  - ALIAS
```
public static final int ALIAS
```
    See Also:
    Constant Field Values
  - MODELED
```
public static final int MODELED
```
    See Also:
    Constant Field Values
  - GLOBAL
```
public static final int GLOBAL
```
    See Also:
    Constant Field Values
  - STANDARD
```
public static final int STANDARD
```
    See Also:
    Constant Field Values
  - CALCULATED
```
public static final int CALCULATED
```
    See Also:
    Constant Field Values
  - MAP_SIZE
```
public static final int MAP_SIZE
```
    See Also:
    Constant Field Values
  - ENUM_ENTRY_NAME
```
public static final String ENUM_ENTRY_NAME
```
    See Also:
    Constant Field Values
  - ENUM_ENTRY_DISPLAY
```
public static final String ENUM_ENTRY_DISPLAY
```
    See Also:
    Constant Field Values
  - ENUM_DESC_PREFIX
```
public static final String ENUM_DESC_PREFIX
```
    See Also:
    Constant Field Values
  - ENUM_ENTRY_DESC
```
public static final String ENUM_ENTRY_DESC
```
    See Also:
    Constant Field Values
  - ENUM_ENTRY_ACTIVE
```
public static final String ENUM_ENTRY_ACTIVE
```
    See Also:
    Constant Field Values
  - ENUM_ENTRY_SORT
```
public static final String ENUM_ENTRY_SORT
```
    See Also:
    Constant Field Values
  - ENUM_ENTRY_KEY
```
public static final String ENUM_ENTRY_KEY
```
    See Also:
    Constant Field Values
  - PRECISIONS
```
public static final String PRECISIONS
```
    See Also:
    Constant Field Values
  - RAW_ATTS
```
public static final String RAW_ATTS
```
    See Also:
    Constant Field Values
  - DECODE_DESCRIPTION
```
public static final String DECODE_DESCRIPTION
```
    See Also:
    Constant Field Values
  - DESCRIPTION_URL_DELIMITER
```
public static final String DESCRIPTION_URL_DELIMITER
```
    See Also:
    Constant Field Values
  - FORMATTERT
```
public static FastDateFormat FORMATTERT
```
- Constructor Detail
  - AttMagic
```
public AttMagic()
```
    simple constructor if data map and object to update are set later
  - AttMagic
```
public AttMagic(Object attHolder)
         throws WTException
```
    create AttMagic object for a persistable.
    
    Parameters:
    attHolder - persistable to read/write atts from
    
    Throws:
    
    WTException
  - AttMagic
```
public AttMagic(AttMagic template)
         throws WTException
```
    initialize Attmagic from a template object (create a static one, set desired flag, from this construct new ones)
    
    Parameters:
    template -
    
    Throws:
    
    WTException
  - AttMagic
```
public AttMagic(Object attHolder,
        AttMagic template)
         throws WTException
```
    create AttMagic object for a persistable from a template AttMagic objects (thus allowing to preserve settings)
    
    Parameters:
    attHolder - persistable to read/write atts from
    template - AttMagic object to copy settings from
    
    Throws:
    
    WTException
- Method Detail
  - toString
```
public String toString()
```
    gets more verbose depending on log4j log level (DEBUG shows settings, TRACE shows initial data map)
    
    Overrides:
    
    toString in class Object
  - getAttHolder
```
public Persistable getAttHolder()
```
    see setter method.
    
    Returns:
    attHolder value
  - setAttHolder
```
public AttMagic setAttHolder(Object attHolder)
```
    set the Persistable to read/write atts from - can be an OBID or ObjectRef too.
    
    Parameters:
    attHolder - obj to read/write
  - getDefaultForMissingAtts
```
public String getDefaultForMissingAtts()
```
    see setter method.
    
    Returns:
    flag value
  - setDefaultForMissingAtts
```
public AttMagic setDefaultForMissingAtts(String defaultForMissingAtts)
```
    if set this value will be put in the result map for missing attributes
    
    Parameters:
    defaultForMissingAtts - a string to use as default
  - isRemove
```
public boolean isRemove()
```
    see setter method.
    
    Returns:
    flag value
  - setRemove
```
public AttMagic setRemove(boolean remove)
```
    flag if the written values should be removed from the (copied) map - set to false to call same AttMagic for more than one Object
    
    Parameters:
    remove - new value for flag
  - isWithUnits
```
public boolean isWithUnits()
```
    see setter method.
    
    Returns:
    flag value
  - setWithUnits
```
public AttMagic setWithUnits(boolean withUnits)
```
    flag if the result of a float-with-unit should contain the unit too (default=true)
    
    Parameters:
    withUnits - new value for flag
  - getMultiValBehavior
```
public int getMultiValBehavior()
```
    see setter method.
    
    Returns:
    flag value
  - setMultiValBehavior
```
public AttMagic setMultiValBehavior(int multiValBehavior)
```
    configure what to do if multivalue IBA found:
    - MULTIVAL_ERR throws an Exception
    - MULTIVAL_ANY returns the last value seen
    - MULTIVAL_LIST returns a List object with the values in it
    - MULTIVAL_SET returns a Set with the values in it
    default=MULTIVAL_ERR.
    Parameters:
    multiValBehavior - the new value
  - isMasterAttsOverride
```
public boolean isMasterAttsOverride()
```
    see setter method.
    
    Returns:
    flag value
  - setMasterAttsOverride
```
public AttMagic setMasterAttsOverride(boolean masterAttsOverride)
```
    if master adds are added to the map, should they override the iteration's values? default=false;
    
    Parameters:
    masterAttsOverride - new value for flag
  - isRefresh
```
public boolean isRefresh()
```
    see setter method.
    
    Returns:
    flag value
  - setRefresh
```
public AttMagic setRefresh(boolean noRefresh)
```
    flag to tell if the attHolder is an IBAHolder, should it be refreshed before reading the IBAs? default=true
    
    Parameters:
    noRefresh - the new value for flag
  - isAddCalculated
```
public boolean isAddCalculated()
```
    see setter method.
    
    Returns:
    flag value
  - setAddCalculated
```
public AttMagic setAddCalculated(boolean addCalculated)
```
    flag to tell if the result Map should also contain calculated atts - default=false
    
    Parameters:
    addCalculated - the new value for flag
  - isIterate
```
public boolean isIterate()
```
    see setter method.
    
    Returns:
    flag value
  - setIterate
```
public AttMagic setIterate(boolean iterate)
```
    flag to tell if the object should be iterated before forced update (=iterate but override constraints)
    
    Parameters:
    iterate - the new value for flag
    
    Returns:
    the Attmagic obj to allow chaining calls
  - isAddAlias
```
public boolean isAddAlias()
```
    see setter method.
    
    Returns:
    flag value
  - setAddAlias
```
public AttMagic setAddAlias(boolean addAlias)
```
    flag to tell if the result Map should also contain alias atts - default=false
    
    Parameters:
    addAlias - the new value for flag
  - isUpdateToEmpty
```
public boolean isUpdateToEmpty()
```
    see setter method.
    
    Returns:
    flag value
  - setUpdateToEmpty
```
public AttMagic setUpdateToEmpty(boolean updateToEmpty)
```
    flag to tell update to an empty value should delete the xxxvalue (default=false, consistent with old/UpdateIBAs behaviour) if set to true will update existing iba values to empty rather than delete
    
    Parameters:
    addAlias - the new value for flag
  - setData
```
public AttMagic setData(Map<String,Object> values)
```
    set a new data Map NOTE: AttMagic stores a copy of the Map, so first fill it, then call this method!
    
    Parameters:
    values - the new Map to use
    
    Returns:
    the Attmagic obj to allow chaining calls
  - setQueryAtts
```
public AttMagic setQueryAtts(Set<String> attNamesSet)
```
    set a new asked-for atts set
    NOTE: AttMagic stores a copy of the Set, so first fill it, then call this method!
    
    Parameters:
    values - the new Set to use
    
    Returns:
    the Attmagic obj to allow chaining calls
  - set
```
public AttMagic set(String key,
           Object value)
```
    add a key/value pair to the data Map - overrides existing key/values
    
    Parameters:
    key - new key
    value - new value
    
    Returns:
    the Attmagic obj to allow chaining calls
  - set
```
public AttMagic set(Map moreVals)
```
    add key/values to data map (assumes keys are Strings!)
    
    Parameters:
    moreVals -
    
    Returns:
    the Attmagic obj to allow chaining calls
  - isKeepCheckedOut
```
public boolean isKeepCheckedOut()
```
    see setter method.
    
    Returns:
    flag value
  - setKeepCheckedOut
```
public AttMagic setKeepCheckedOut(boolean keepCheckedOut)
```
    flag to kepp the attHolder checked-out if AttMagic checked it out for update.
    
    Parameters:
    keepCheckedOut - the new value for flag
  - isValidate
```
public boolean isValidate()
```
    see setter method.
    
    Returns:
    flag value
  - setValidate
```
public AttMagic setValidate(boolean validate)
```
    flag to force a constraint check even for forced update (not yet implemented) - default=false
    
    Parameters:
    validate - the new value for flag
  - getCheckinMessage
```
public String getCheckinMessage()
```
    see setter method.
    
    Returns:
    the checkin message set, default="auto checkin for AttMagic ..."
  - setCheckinMessage
```
public AttMagic setCheckinMessage(String checkinMessage)
```
    override default AttMagic checkin message
    
    Parameters:
    checkinMessage - the message to use
    
    Returns:
    the Attmagic obj to allow chaining calls
  - getCheckoutMessage
```
public String getCheckoutMessage()
```
    see setter method.
    
    Returns:
    the checkout message set, default="auto checkout for AttMagic ..."
  - setCheckoutMessage
```
public AttMagic setCheckoutMessage(String checkoutMessage)
```
    override default AttMagic checkout message
    
    Parameters:
    checkoutMessage - the message to use
  - isAddValues
```
public boolean isAddValues()
```
    see setter method.
    
    Returns:
    flag value
  - setAddValues
```
public AttMagic setAddValues(boolean addValues)
```
    flag to make AttMagic add IBAs without deleting existing values (creates multivalue) default=false
    
    Parameters:
    addValues - the new value for flag
  - isCreateEmpty
```
public boolean isCreateEmpty()
```
    see setter method.
    
    Returns:
    flag value
  - setClearMissing
```
public AttMagic setClearMissing(boolean clear)
```
    should AttMagic clear existing values not passed in map? default=false Note: this only works with forcedUpdate=true
    
    Parameters:
    clear -
  - isClearMissing
```
public boolean isClearMissing()
```
  - setCreateEmpty
```
public AttMagic setCreateEmpty(boolean createEmpty)
```
    should AttMagic create empty IBA values? default=false
    
    Parameters:
    createEmpty -
  - isForcedUpdate
```
public boolean isForcedUpdate()
```
    see setter method.
    
    Returns:
    flag value
  - setForcedUpdate
```
public AttMagic setForcedUpdate(boolean forcedUpdate)
```
    flag if update must happen without check-out - default=false
    
    Parameters:
    forcedUpdate - the new value for flag
  - setForcedUpdate
```
public AttMagic setForcedUpdate(boolean forcedUpdate,
                       boolean iterate)
```
    flag if forced update must happen - if iterate=true run forced update on a newly created iteration (same as setForcedUpdate(true).setIterate(true) )
    
    Parameters:
    forcedUpdate - the new value for forcedUpdate flag
    iterate - the new value for iterate flag
  - isWithMeta
```
public boolean isWithMeta()
```
    see setter method.
    
    Returns:
    flag value
  - setWithMeta
```
public AttMagic setWithMeta(boolean withMeta)
```
    flag if atts returned must contain meta inforamtion about the atts themselves (not yet implemented)
    
    Parameters:
    withMeta - the new value for flag
  - isAddMasterAtts
```
public boolean isAddMasterAtts()
```
    see setter method.
    
    Returns:
    flag value
  - setAddMasterAtts
```
public AttMagic setAddMasterAtts(boolean addMasterAtts)
```
    flag if the attributes of the Master (if attHolder is RevisionControlled) should be added to result Map
    
    Parameters:
    addMasterAtts - the new value for flag
  - isAddAdhocIBAs
```
public boolean isAddAdhocIBAs()
```
    see setter method.
    
    Returns:
    flag value
  - isForceCSM
```
public boolean isForceCSM()
```
    see setter method.
    
    Returns:
    flag value
  - isForceFT
```
public boolean isForceFT()
```
    see setter method.
    
    Returns:
    flag value
  - setAddAdhocIBAs
```
public AttMagic setAddAdhocIBAs(boolean addAdhocIBAs)
```
    flag if AdHoc IBAs should be read/written (default = false)
    
    Parameters:
    addAdhocIBAs - the new value for flag
  - setForceCSM
```
public AttMagic setForceCSM(boolean isCSM)
```
    flag to set if classification nodes need to be written (default = false)
    
    Parameters:
    addAdhocIBAs - the new value for flag
  - setForceFT
```
public AttMagic setForceFT(boolean isFT)
```
    flag to set if family table epmdocs need to be written (default = false)
    
    Parameters:
    addAdhocIBAs - the new value for flag
  - getDateFormat
```
public FastDateFormat getDateFormat()
```
    see setter method.
    
    Returns:
    the SimpleDateFormat used to format date attributes to text
  - setDateFormat
```
public AttMagic setDateFormat(String dateFormat)
```
    set new date format for date parsing
    
    Parameters:
    dateFormat - new format string, see java.text.SimpleDateFormat
  - setDateFormat
```
public AttMagic setDateFormat(FastDateFormat dateFormat)
```
    set new date format for date parsing
    
    Parameters:
    dateFormat - new SimpleDateFormat to use
  - getTypeName
```
public String getTypeName()
```
    the attHolder's type.
    
    Returns:
    the (to-be-set) type name
  - getNewTypeName
```
public String getNewTypeName()
```
    see setter method.
    
    Returns:
    flag value
  - setNewTypeName
```
public AttMagic setNewTypeName(String newTypeName)
                        throws WTException
```
    if set will re-type the attHolder to a different type. default=null
    
    Parameters:
    newTypeName - last part of type name including reversed internet domain (e.g. WCTYPE|wt.part.WTPart|de.sulis.SulisPart)
    
    Throws:
    
    WTException
  - main
```
public static void main(String[] a)
                 throws Exception
```
    print program usage info or invoke test cases
    
    Parameters:
    a - commandline args
    
    Throws:
    
    Exception
  - encode
```
public static String encode(String in)
                     throws WTException
```
    encode a string for use as internal enum value: if it contains only acceptable values (in old 10 versions it could contain digits but not start with one) it is prefixed with 'x', else prefix is 'y' and the interal value is base64 encoded
    
    Parameters:
    in - the true internal value - as passed to AttMagic setAtts
    
    Returns:
    the encoded value to store in the global enum
    
    Throws:
    
    WTException
  - decode
```
public static String decode(String in)
                     throws WTException
```
    decode the encoded internal enum value into the real internal value - as returned by AttMagic getAtts
    
    Parameters:
    in - the internal enum value
    
    Returns:
    the true internal value - as returned by AttMagic getAtts
    
    Throws:
    
    WTException
  - getSortedEnumDisplayValues
```
public static List<String[]> getSortedEnumDisplayValues(String enumName,
                                        boolean selOnly)
                                                 throws WTException
```
    return the default display values of an enumeration
    
    Parameters:
    enumName - the internal global enumeration name
    selOnly - true to return only enabled entries
    
    Returns:
    a sorted (localspecific) List of key/display pairs
    
    Throws:
    
    WTException - if enum not found
  - getSortedEnumDisplayValues
```
public static List<String[]> getSortedEnumDisplayValues(String enumName,
                                        boolean selOnly,
                                        Locale locale)
                                                 throws WTException
```
    return the localized display value of an enumeration entry, tries language_country, language, default display
    
    Parameters:
    enumName - the internal global enumeration name
    selOnly - true to return only enabled entries
    locale - name of locale (e.g., en_US, de)
    
    Returns:
    a sorted (localspecific) List of key/display pairs
    
    Throws:
    
    WTException - if enum not found
  - getSortedEnumDisplayValues
```
public static List<String[]> getSortedEnumDisplayValues(String enumName,
                                        boolean selOnly,
                                        String[] locale)
                                                 throws WTException
```
    return the first localized display value of an enumeration entry from the list passed in locale
    
    Parameters:
    enumName - the internal global enumeration name
    selOnly - true to return only enabled entries
    locale - names of locales to test (e.g., en_US, en, ENUM_ENTRY_DISPLAY)
    
    Returns:
    the localized string or the default display value if no locale specific entry exists
    
    Throws:
    
    WTException - if no entry found or no display value exists
  - getEnumDisplayValue
```
public static String getEnumDisplayValue(String enumName,
                         String entryName)
                                  throws WTException
```
    return the default display value of an enumeration entry
    
    Parameters:
    enumName - the internal global enumeration name
    entryName - the internal name of the key
    
    Returns:
    the default display value
    
    Throws:
    
    WTException - if enum or key not found or no display value exists
  - getEnumDisplayValue
```
public static String getEnumDisplayValue(String enumName,
                         String entryName,
                         Locale locale)
                                  throws WTException
```
    return the localized display value of an enumeration entry, tries language_country, language, default display
    
    Parameters:
    enumName - the internal global enumeration name
    entryName - the internal name of the key
    locale - name of locale (e.g., en_US, de)
    
    Returns:
    the localized string or the default display value if no locale specific entry exists
    
    Throws:
    
    WTException - if enum or key not found or no display value exists
  - getEnumEntryMap
```
public static Map<String,String> getEnumEntryMap(String enumName,
                                 String entryName)
                                          throws WTException
```
    return infos about an entry in a global enum, @see getEntryMaps
    
    Parameters:
    enumName - internal name of global enum
    entryName - internal name of enum entry to find infos for
    
    Returns:
    map with info as described in getEntryMaps
    
    Throws:
    
    WTException
  - getEnumDisplayValue
```
public static String getEnumDisplayValue(String enumName,
                         String entryName,
                         String[] locale)
                                  throws WTException
```
    return the first localized display value of an enumeration entry from the list passed in locale
    
    Parameters:
    enumName - the internal global enumeration name
    entryName - the internal name of the key
    locale - names of locales to test (e.g., en_US, en, ENUM_ENTRY_DISPLAY)
    
    Returns:
    the localized string or the default display value if no locale specific entry exists
    
    Throws:
    
    WTException - if no entry found or no display value exists
  - getEnumValueSelectable
```
public static boolean getEnumValueSelectable(String enumName,
                             String entryName)
                                      throws WTException
```
    tell if an enumeration entry is selectable
    
    Parameters:
    enumName - the internal global enumeration name
    entryName - the internal name of the key
    
    Returns:
    true/false
    
    Throws:
    
    WTException - if no entry found or no display value exists
  - getEnumDescriptionValue
```
public static String getEnumDescriptionValue(String enumName,
                             String entryName)
                                      throws WTException
```
    return the default description value of an enumeration entry
    
    Parameters:
    enumName - the internal global enumeration name
    entryName - the internal name of the key
    
    Returns:
    the default description value
    
    Throws:
    
    WTException - if enum or key not found
  - getEnumDescriptionValue
```
public static String getEnumDescriptionValue(String enumName,
                             String entryName,
                             Locale locale)
                                      throws WTException
```
    return the localized description value of an enumeration entry, tries language_country, language, default description
    
    Parameters:
    enumName - the internal global enumeration name
    entryName - the internal name of the key
    locale - name of locale (e.g., en_US, de)
    
    Returns:
    the localized string or the default description value if no locale specific entry exists
    
    Throws:
    
    WTException - if enum or key not found
  - getEnumDescriptionValue
```
public static String getEnumDescriptionValue(String enumName,
                             String entryName,
                             String[] locale)
                                      throws WTException
```
    return the first localized description value of an enumeration entry from the list passed in locale
    
    Parameters:
    enumName - the internal global enumeration name
    entryName - the internal name of the key
    locale - names of locales to test (e.g., en_US, en, ENUM_ENTRY_DISPLAY)
    
    Returns:
    the localized string or the default description value if no locale specific entry exists
    
    Throws:
    
    WTException - if no entry found or no description value exists
  - isEnumEncoded
```
public static boolean isEnumEncoded(String enumName)
                             throws WTException
```
    tell if enum has encoded internal values (must have the string AttMagic decode in it's description
    
    Parameters:
    enumName -
    
    Returns:
    
    Throws:
    
    WTException
  - getEntryMaps
```
public static List<Map<String,String>> getEntryMaps(String enumName)
                                             throws WTException
```
    return for the global enumeration enumName a Map indexed with the enumeration entry keys and a Map as value holding name, other info and locale specific data:
    
    Parameters:
    enumName - the internal name of the enumeration
    
    Returns:
    Map as described above
    
    Throws:
    
    WTException - if enum not found.
  - _main
```
public static Object _main(Class mec,
           String[] args)
                    throws Exception
```
    to invoke main in MS
    
    Parameters:
    mec - class of AttMagic (may be subclassed)
    args - String[] passed from main() call
    
    Returns:
    an AttMagic object or a usage string
    
    Throws:
    
    WTException
    
    Exception
  - getAtt
```
public Object getAtt(String name)
              throws WTException
```
    return the value for attribute by name
    
    Parameters:
    name -
    
    Returns:
    the att value as java object
    
    Throws:
    
    WTException
  - custPreRead
```
public void custPreRead(Persistable obid)
                 throws WTException
```
    subclass can implement custom logic here
    
    Parameters:
    obid - the attribute holder
    
    Throws:
    
    WTException
  - custTypeChanged
```
public void custTypeChanged(Persistable obid)
                     throws WTException
```
    subclass can implement custom logic here
    
    Parameters:
    obid - the attribute holder
    
    Throws:
    
    WTException
  - custPostRead
```
public void custPostRead(Persistable obid)
                  throws WTException
```
    subclass can implement custom logic here
    
    Parameters:
    obid - the attribute holder
    
    Throws:
    
    WTException
  - custPreWrite
```
public void custPreWrite(Persistable attHolder2)
                  throws WTException
```
    subclass can implement custom logic here
    
    Parameters:
    obid - the attribute holder
    
    Throws:
    
    WTException
  - custPostWrite
```
public void custPostWrite(Persistable obid)
                   throws WTException
```
    subclass can implement custom logic here
    
    Parameters:
    obid - the attribute holder
    
    Throws:
    
    WTException
  - getAtts
```
public Map<String,String> getAtts()
                           throws WTException
```
    return the holder's attributes as strings
    
    Returns:
    a Map with attname/attvalue pairs
    
    Throws:
    
    WTException
  - getAtts
```
public Map<String,String> getAtts(Persistable from)
                           throws WTException
```
    read the attributes of an object, hiding the storage (standard att versus global (iba)) - just returns a map<String,String>
    
    Parameters:
    from - object to fetch atts from
    
    Returns:
    results map
    
    Throws:
    
    WTException
  - getRawAtts
```
public Map<String,Object> getRawAtts()
                              throws WTException
```
    return the holder's attributes as java objects.
    as a side effect populates the Map precisions with the precision value[s] of the real/unit values read from the database.
    
    Returns:
    a Map with attname/attvalue pairs
    
    Throws:
    
    WTException
  - getRawAtts
```
public Map<String,Object> getRawAtts(Persistable from)
                              throws WTException
```
    return the persistable's attributes as java objects.
    as a side effect populates the Map precisions with the precision value[s] of the real/unit values read from the database.
    
    Parameters:
    from -
    
    Returns:
    
    Throws:
    
    WTException
  - getRawAtts
```
public Map<String,Object> getRawAtts(Persistable from,
                            boolean addPrecision)
                              throws WTException
```
    return the persistable's attributes as java objects., optionally also retrieve the precisions to use
    after the call the proteced Map precisions with the precision value[s] of the real/unit values read from the database is populated.
    
    Parameters:
    from -
    addPrecision - flag if we also want precision information
    
    Returns:
    if addPrecision is true result is a Map<String, Map<String, Object>>: key AttMagic.RAW_ATTS gives the attribues, key AttMagic.PRECISIONS gives the precision to use (or null if unknown)
    else the result is the Map<String, Object> with the attributes
    
    Throws:
    
    WTException
  getGetters
  
  public static Map<String,Method> getGetters(Class cls)
  
  return a Map with ptcXXX key/Method values for a given class
  
  Parameters:
  cls -
  
  Returns:
  
  typeName
  
  public static String typeName(Object typed) throws WTException
  
  returns the type name
  
  Parameters:
  typed - the input object to test
  
  Returns:
  the type name (without parent information)
  
  Throws:
  
  WTException
  
  shortTypeName
  
  public static String shortTypeName(Object typed) throws WTException
  
  returns the shortened type name (without the reversed internet domain)
  
  Parameters:
  typed - the input object to test
  
  Returns:
  the type name after removing leading text up to rightmost ˙
  
  Throws:
  
  WTException
  
  getAttributesNames
  
  public static Map<String,String> getAttributesNames(Object typed) throws WTException
  
  deliver a map of global and standard attributes for given typed obj
  
  Returns:
  
  Throws:
  
  WTException
  
  getAttsInfo
  
  public static Map<String,AttMagic.A>[] getAttsInfo(Object typed) throws WTException
  
  deliver info about the type's attributes, grouped by attribute type
  
  Returns:
  an array of Maps of size MAP_SIZE, indexed by attribute type (ALIAS, MODELED, GLOBAL, STANDARD, CALCULATED) with Atts, looked up by internal Attribute Name,
  
  Throws:
  
  WTException
  
  getAttsInfo
  
  public static Map<String,AttMagic.A>[] getAttsInfo(String type) throws WTException
  
  deliver info about the type's attributes, grouped by attribute type
  
  Returns:
  an array of Maps of size MAP_SIZE, indexed by attribute type (ALIAS, MODELED, GLOBAL, STANDARD, CALCULATED) with Atts, looked up by internal Attribute Name,
  
  Throws:
  
  WTException
  
  getAtt
  
  public static AttMagic.A getAtt(String type, String att) throws WTException
  
  deliver info about the attribute in the type
  
  Returns:
  one A (tt)
  
  Throws:
  
  WTException
  
  findAtt
  
  public static List<AttMagic.A> findAtt(String attRe) throws WTException
  
  deliver info about atts in type[s] passing a regex against the att name
  
  Returns:
  the list of A(tts) matching the Attribute Name
  
  Throws:
  
  WTException
  
  getT
  
  public static AttMagic.T getT(String typeName) throws WTException
  
  Throws:
  
  WTException
  
  getT
  
  public static List<AttMagic.T> getT() throws WTException
  
  return a List of all type info objects (T)
  
  Returns:
  
  Throws:
  
  WTException
  
  findAtt
  
  public static List<AttMagic.A> findAtt(String typeName, String attRe) throws WTException
  
  deliver info about atts in type[s] passing a regex against the att name
  
  Returns:
  the list of A(tts) matching the Attribute Name
  
  Throws:
  
  WTException
  
  setType
  
  public AttMagic setType() throws WTException
  
  retype the holder with the newTypeName type
  
  Returns:
  self for chaining calls
  
  Throws:
  
  WTException
  
  update
  
  public Persistable update(Map<String,Object> values) throws WTException
  
  set the attHolder's attributes for the keys passed in the values Map, hiding the storage (standard att versus global (iba))
  
  Parameters:
  values - a map with new values to set
  
  Throws:
  
  WTException
  
  update
  
  public Persistable update() throws WTException
  
  set the attHolder's attributes to the values in the internal new-values Map, hiding the storage (standard att versus global (iba))
  
  Throws:
  
  WTException
  
  forcedCopyStdAtts
  
  public static void forcedCopyStdAtts(Object from, Object to) throws Exception
  
  copy the standard attributes of one object to another - just sets the typeinfo object of the old to the new holder.
  
  Parameters:
  from -
  to -
  
  Throws:
  
  Exception
  
  forceAtts
  
  public Persistable forceAtts() throws WTException
  
  forcefully update atts - no checkout.
  
  Returns:
  the attHolder
  
  Throws:
  
  WTException
  
  updateIBAs
  
  public void updateIBAs(Map<String,Object> ibas) throws WTException
  
  update the IBAs of obj
  
  Parameters:
  ibas -
  
  Throws:
  
  WTException
  
  hasWriteableAtt
  
  public static boolean hasWriteableAtt(String type, String att) throws WTException
  
  determines if the type has a writable attribute with given name
  
  Parameters:
  type - name of (soft)type to test
  att - name of att to check
  
  Returns:
  result of test
  
  Throws:
  
  WTException
  
  hasReadableAtt
  
  public boolean hasReadableAtt(String att) throws WTException
  
  determines if AttMagic's holder has a readable attribute with given name
  
  Parameters:
  att - name of att to check
  
  Returns:
  result of test
  
  Throws:
  
  WTException
  
  hasReadableAtt
  
  public static boolean hasReadableAtt(Persistable typed, String att) throws WTException
  
  determines if typed objects type has a readable attribute with given name
  
  Parameters:
  typed - Persistable to test
  att - name of att to check
  
  Returns:
  result of test
  
  Throws:
  
  WTException
  
  hasWriteableAtt
  
  public boolean hasWriteableAtt(String att) throws WTException
  
  determines if AttMagic's holder has a writable attribute with given name
  
  Parameters:
  att - name of att to check
  
  Returns:
  result of test
  
  Throws:
  
  WTException
  
  hasWriteableAtt
  
  public static boolean hasWriteableAtt(Persistable typed, String att) throws WTException
  
  determines if the typed object's type has a writable attribute with given name
  
  Parameters:
  typed - Persistable to test
  att - name of att to check
  
  Returns:
  result of test
  
  Throws:
  
  WTException
  
  hasReadableAtt
  
  public static boolean hasReadableAtt(String type, String att) throws WTException
  
  determines if type has a readable attribute with given name
  
  Parameters:
  type -
  att -
  
  Returns:
  result of test
  
  Throws:
  
  WTException
  
  TNWRID
  
  public static String TNWRID(String type) throws WTException
  
  return the type name with the reversed Site internet domain or java package, but without parent[s] info (wt.part.WTPart / WTPart)
  
  Parameters:
  type -
  
  Returns:
  
  Throws:
  
  WTException
  
  typeChanged
  
  public static Map typeChanged(Map in)
  
  allows PremiumService to notify AttMagic about type setup changes
  
  Parameters:
  in - Map with event
  
  Returns:
  Map with trigger result (see Sulis' PremiumEventService)
  
  startup
  
  public static Map startup(Map in) throws Exception
  
  allows PremiumService to initialize AttMagic
  
  Parameters:
  in - Map with event
  
  Returns:
  Map with trigger result (see Sulis' PremiumEventService)
  
  Throws:
  
  Exception
  
  hasDelta
  
  public boolean hasDelta(Map<String,Object> toBe) throws WTException
  
  return true if holder's atts differ from the ones in the toBe Map.
  
  Parameters:
  toBe - atts we need.
  
  Returns:
  true if anything differs from object's atts
  
  Throws:
  
  WTException
  
  hasDelta
  
  public boolean hasDelta(Map<String,Object> toBe, Set ignore) throws WTException
  
  Parameters:
  toBe - atts we need.
  ignore - Set with attribute names to ignore
  
  Returns:
  true if anything differs from object's atts
  
  Throws:
  
  WTException
  
  queryObject
  
  public Map<String,Object> queryObject() throws WTException
  
  run query-objects against the internal object and return the Map with results for standard/global attributes, plus alias and/or calculated if requested by setup
  
  Returns:
  the attributes in a Map
  
  Throws:
  
  WTException
  
  queryObject
  
  public Map<String,Object> queryObject(Object from) throws WTException
  
  run query-objects against object and return the Map with results for standard/global attributes, plus alias and/or calculated if requested by setup
  
  Parameters:
  from - obj to get atts for
  
  Returns:
  
  Throws:
  
  WTException
  
  queryObject
  
  public Map<String,Object> queryObject(Object from, boolean onlyRO) throws WTException
  
  run query-objects against object and return the Map with results for standard/global attributes, plus alias and/or calculated if requested by setup
  
  Parameters:
  from - obj to get atts for
  onlyRO - flag whether we only want alias and calculated atts
  
  Returns:
  
  Throws:
  
  WTException
  
  queryObject
  
  public Map<String,Object> queryObject(Object from, boolean onlyRO, boolean addModeled) throws WTException
  
  run query-objects against object and return the Map with results for standard/global attributes, plus alias and/or calculated if requested by setup
  
  Parameters:
  from - obj to get atts for
  onlyRO - flag whether we only want alias and calculated atts
  addModeled - flag if we also want modeled atts
  
  Returns:
  
  Throws:
  
  WTException
  
  findObjects
  
  public static List<Persistable> findObjects(String type, Map<String,String> where) throws WTException
  
  find objects of given type with criteria passed in a Map (where key=value ...)
  
  Parameters:
  type -
  where -
  
  Returns:
  list of persistables matching criteria
  
  Throws:
  
  WTException
  
  getTypeNames
  
  public static Set<String> getTypeNames() throws WTException
  
  return a list of all type names
  
  Returns:
  
  Throws:
  
  WTException
  
  getTypes
  
  public static Map<String,AttMagic.T> getTypes() throws WTException
  
  Throws:
  
  WTException
  
  readExternal
  
  public void readExternal(ObjectInput objectinput) throws IOException, ClassNotFoundException
  
  deserialization.
  
  Specified by:
  
  readExternal in interface Externalizable
  
  Throws:
  
  IOException
  
  ClassNotFoundException
  
  writeExternal
  
  public void writeExternal(ObjectOutput objectoutput) throws IOException
  
  serialization
  
  Specified by:
  
  writeExternal in interface Externalizable
  
  Throws:
  
  IOException

Class AttMagic

Nested Class Summary

Field Summary

Fields inherited from interface RemoteAccess

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

MAJOR

MINOR

LOCK

EDIT_IBAS

MULTIVAL_ERR

MULTIVAL_ANY

MULTIVAL_LIST

MULTIVAL_SET

DATE_WITH_TIME

ALIAS

MODELED

GLOBAL

STANDARD

CALCULATED

MAP_SIZE

ENUM_ENTRY_NAME

ENUM_ENTRY_DISPLAY

ENUM_DESC_PREFIX

ENUM_ENTRY_DESC

ENUM_ENTRY_ACTIVE

ENUM_ENTRY_SORT

ENUM_ENTRY_KEY

PRECISIONS

RAW_ATTS

DECODE_DESCRIPTION

DESCRIPTION_URL_DELIMITER

FORMATTERT

Constructor Detail

AttMagic

AttMagic

AttMagic

AttMagic

Method Detail

toString

getAttHolder

setAttHolder

getDefaultForMissingAtts

setDefaultForMissingAtts

isRemove

setRemove

isWithUnits

setWithUnits

getMultiValBehavior

setMultiValBehavior

isMasterAttsOverride

setMasterAttsOverride

isRefresh

setRefresh

isAddCalculated

setAddCalculated

isIterate

setIterate

isAddAlias

setAddAlias

isUpdateToEmpty

setUpdateToEmpty

setData

setQueryAtts

set

set

isKeepCheckedOut

setKeepCheckedOut

isValidate

setValidate

getCheckinMessage

setCheckinMessage

getCheckoutMessage

setCheckoutMessage

isAddValues

setAddValues

isCreateEmpty

setClearMissing