Modifier (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.dmc.types.Modifier

All Implemented Interfaces:

Serializable
```
public class Modifier
extends Object
implements Serializable
```
The Modifier type is used to represent modification operations on a DmcObject. Any modification to an object can be represented by a Modifier. Modifiers exist in two primary states, depending on how they are created. If the modification is created as a result of setting a DmcTypeModifier on a DmcObject and applying a series of changes, the modification is (at least partially) resolved. If the changes take place on a client, the changes are partially resolved e.g. references to objects are not fully resolved. If the changes take place on the server, the modification should be fully resolved.
Modifiers that are parsed from an OIF or JSON formatted request are not resolved and must be resolved before they are applied to server side objects.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Modifier()` The mandatory zero arg constructor.
`Modifier(Modifier original)` The copy constructor.
`Modifier(ModifyTypeEnum op, DmcAttribute<?> attr)` Constructs a new Modifier.
`Modifier(ModifyTypeEnum op, DmcAttribute<?> attr, DmcObject referrer)` Constructs a new backref Modifier.
`Modifier(ModifyTypeEnum op, DmcAttribute<?> attr, DmcObject referrer, int idx)` Constructs a new backref Modifier for indexed attributes.
`Modifier(ModifyTypeEnum op, DmcAttribute<?> attr, int idx)` Constructs a new Modifier for the modification of an indexed attribute.
`Modifier(ModifyTypeEnum op, DmcAttributeInfo ai)` Constructs a new Modifier for removal of an attribute
`Modifier(ModifyTypeEnum op, DmcAttributeInfo ai, int idx)` Constructs a new Modifier for setting of the specified index to null.
`Modifier(String v)` Constructs a new Modifier.
`Modifier(String pn, DmcObject referrer, DmcNamedObjectREF<?> ctr)` Constructs a new backref Modifier for a reference from within a complex type.
`Modifier(String pn, DmcObject referrer, DmcNamedObjectREF<?> ctr, int ai)` Same as above, but with the attribute ID passed in so that we can support DmcObject.getReferringObjectsViaAttribute().
`Modifier(String pn, DmcObject referrer, DmcNamedObjectREF<?> ctr, int ai, String an)` Same as above, but with the attribute ID passed in so that we can support DmcObject.getReferringObjectsViaAttribute().

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deserializeIt(DmcInputStreamIF dis)`
`DmcAttribute<?>`	`getAttribute()` Returns the attribute holder if available.
`int`	`getAttributeID()`
`DmcAttributeInfo`	`getAttributeInfo()`
`String`	`getAttributeName()`
`int`	`getIndex()`
`ModifyTypeEnum`	`getModifyType()`
`String`	`getPartName()`
`DmcNamedObjectIF`	`getReferringObject()`
`DmcNamedObjectREF<?>`	`getRefFromComplexType()`
`Object`	`getValue()`
`boolean`	`isResolved()` A modification is considered resolved if it has a DmcAttribute to contain the value associated with the modification operation, or, if the operation is an REM.
`void`	`serializeIt(DmcOutputStreamIF dos)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Modifier
```
public Modifier()
```
    The mandatory zero arg constructor.
  - Modifier
```
public Modifier(Modifier original)
```
    The copy constructor.
    
    Parameters:
    
    original -
  - Modifier
```
public Modifier(ModifyTypeEnum op,
                DmcAttribute<?> attr)
```
    Constructs a new Modifier.
    
    Parameters:
    
    op - The operation.
    
    attr - The attribute.
  - Modifier
```
public Modifier(ModifyTypeEnum op,
                DmcAttributeInfo ai)
```
    Constructs a new Modifier for removal of an attribute
    
    Parameters:
    
    op - The operation.
    
    ai - The attribute info.
  - Modifier
```
public Modifier(ModifyTypeEnum op,
                DmcAttribute<?> attr,
                int idx)
```
    Constructs a new Modifier for the modification of an indexed attribute.
    
    Parameters:
    
    op - The operation.
    
    attr - The attribute.
    
    idx - The index being altered.
  - Modifier
```
public Modifier(ModifyTypeEnum op,
                DmcAttributeInfo ai,
                int idx)
```
    Constructs a new Modifier for setting of the specified index to null.
    
    Parameters:
    
    op - The operation.
    
    ai - The attribute info.
    
    idx - The index being set to null.
  - Modifier
```
public Modifier(ModifyTypeEnum op,
                DmcAttribute<?> attr,
                DmcObject referrer)
```
    Constructs a new backref Modifier. This modifier constructs the OPPOSITE of the operation in question i.e. if the operation is SET, the backref modification becomes a REM, if the operation is an ADD, it becomes a DEL. When the object being referred to is deleted, the set of backref modifiers is run against the various objects that were referring to the object.
    
    Parameters:
    
    op - The operation.
    
    attr - The attribute.
    
    referrer - the object that is now referring to another object.
  - Modifier
```
public Modifier(String pn,
                DmcObject referrer,
                DmcNamedObjectREF<?> ctr)
```
    Constructs a new backref Modifier for a reference from within a complex type. References from complex types have to be handled differently since the complex type value is actually immutable. When removing an object, all we do is unresolve the object reference that was passed in.
    
    Parameters:
    
    pn - the name of the part in the complex type that's doing the referring.
    
    referrer - the object that is now referring to another object.
    
    ctr - the reference in the complex type.
  - Modifier
```
public Modifier(String pn,
                DmcObject referrer,
                DmcNamedObjectREF<?> ctr,
                int ai)
```
    Same as above, but with the attribute ID passed in so that we can support DmcObject.getReferringObjectsViaAttribute().
    
    Parameters:
    
    pn - the name of the part in the complex type that's doing the referring.
    
    referrer - the object that is now referring to another object.
    
    ctr - the reference in the complex type.
    
    ai - the attribute id
  - Modifier
```
public Modifier(String pn,
                DmcObject referrer,
                DmcNamedObjectREF<?> ctr,
                int ai,
                String an)
```
    Same as above, but with the attribute ID passed in so that we can support DmcObject.getReferringObjectsViaAttribute().
    
    Parameters:
    
    pn - the name of the part in the complex type that's doing the referring.
    
    referrer - the object that is now referring to another object.
    
    ctr - the reference in the complex type.
    
    ai - the attribute id
    
    an - the attribute name
  - Modifier
```
public Modifier(ModifyTypeEnum op,
                DmcAttribute<?> attr,
                DmcObject referrer,
                int idx)
```
    Constructs a new backref Modifier for indexed attributes. This modifier constructs the OPPOSITE of the operation in question i.e. if you're setting index 2 to point to an object, the opposite operation is to set the index to null.
    
    Parameters:
    
    op - The operation.
    
    attr - The attribute.
    
    referrer - The object that is now referring to another object.
    
    idx - The index through which the reference is made.
  - Modifier
```
public Modifier(String v)
         throws DmcValueException
```
    Constructs a new Modifier. The modify expression must conform to one of the following: ADD DEL SET NTH NTH REM
    
    Parameters:
    
    v - The modification expression.
    
    Throws:
    
    DmcValueException
- Method Detail
  - getRefFromComplexType
```
public DmcNamedObjectREF<?> getRefFromComplexType()
```
  - getAttributeID
```
public int getAttributeID()
```
    Returns:
    
    The attribute ID of the attribute affected by this modifier.
  - getAttributeInfo
```
public DmcAttributeInfo getAttributeInfo()
```
    Returns:
    
    the attribute info for the attribute associated with this modification.
  - getAttribute
```
public DmcAttribute<?> getAttribute()
```
    Returns the attribute holder if available.
    
    Returns:
    
    The attribute holder.
  - getReferringObject
```
public DmcNamedObjectIF getReferringObject()
```
    Returns:
    
    if this is a backref Modifier, this will return the object that's referring to the object on which this modifier is tracked.
  - isResolved
```
public boolean isResolved()
```
    A modification is considered resolved if it has a DmcAttribute to contain the value associated with the modification operation, or, if the operation is an REM.
    
    Returns:
    
    true if resolved and false otherwise
  - getModifyType
```
public ModifyTypeEnum getModifyType()
```
  - getIndex
```
public int getIndex()
```
  - getAttributeName
```
public String getAttributeName()
```
    Returns:
    
    the name of the attribute affected by this operation.
  - getValue
```
public Object getValue()
```
  - getPartName
```
public String getPartName()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - serializeIt
```
public void serializeIt(DmcOutputStreamIF dos)
                 throws Exception
```
    Throws:
    
    Exception
  - deserializeIt
```
public void deserializeIt(DmcInputStreamIF dis)
                   throws Exception
```
    Throws:
    
    Exception

Class Modifier

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Modifier

Modifier

Modifier

Modifier

Modifier

Modifier

Modifier

Modifier

Modifier

Modifier

Modifier

Modifier

Method Detail

getRefFromComplexType

getAttributeID

getAttributeInfo

getAttribute

getReferringObject

isResolved

getModifyType

getIndex

getAttributeName

getValue

getPartName

toString

serializeIt

deserializeIt