Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> metacosm >> framework >> [ entity overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.metacosm.framework.entity
Class Influence  

java.lang.Object
  org.metacosm.framework.entity.Influence

All Implemented Interfaces:

org.metacosm.framework.persistence.Persistent, java.io.Serializable

---

public class Influence

extends java.lang.Object

implements org.metacosm.framework.persistence.Persistent

An Influence defines a Community of similar Entities and how being part this Community "influences" Entities that belongs to it. An Influence gathers Characteristics and other game constructs that are common to the Community of Entities it defines, thus modifying Entities it influences.

---

Field Summary
private  java.util.Map	absoluteModifiers           Absolute modifiers
private  java.util.Map	addedActions           Actions added
private  java.util.Map	addedDescriptionProperties           DescriptionProperties for add
private  java.util.Map	appendDescriptionProperties           DescriptionProperties for append
private  java.lang.String	name           Influence name
private  java.util.Map	properties           Newly defined Properties
private  java.util.Map	relativeModifiers           Relative modifiers
private  java.util.Map	replacedActions           Actions replaced

 

Constructor Summary

Influence(java.lang.String name)

 

Method Summary
void	addAction(org.metacosm.framework.interact.Action action, java.lang.String name)
void	addAction(org.metacosm.framework.interact.Action action, java.lang.String[] names)
void	addDescription(DescriptionProperty d)           Adds a new DescriptionProperty to describe the Entity.
void	addProperty(org.metacosm.util.Property property)           Defines a new Property.
void	appendDescription(DescriptionProperty d)           Appends the value of the DescriptionProperty to a preexistent one with the same name.
java.util.Map	getAbsoluteModifiers()
org.metacosm.framework.interact.Action	getAction(java.lang.String actionId)
java.util.Map	getAddedActions()
java.util.Map	getAddedDescriptions()
java.util.Map	getAppendDescriptions()
java.lang.String	getName()
java.util.Map	getProperties()
java.util.Map	getRelativeModifiers()
java.util.Map	getReplacedActions()
boolean	isApplicableTo(BasicEntity entity)
void	load(java.io.InputStream is)           Loads from the stream.
void	modifyProperty(java.lang.String name, org.metacosm.util.AbsoluteModifier am)           Modifies the Property name with the AbsoluteModifier am.
void	modifyProperty(java.lang.String name, org.metacosm.util.RelativeModifier rm)           Modifies the Property name with the RelativeModifier am.
void	removeAbsoluteModifier(java.lang.String name)           Removes the AbsoluteModifier am on the Property name.
boolean	removeAction(org.metacosm.framework.interact.Action action)
boolean	removeAction(java.lang.String name)
boolean	removeProperty(org.metacosm.util.Property property)           Removes the Property.
boolean	removeProperty(java.lang.String name)           Removes the Property
void	replaceAction(org.metacosm.framework.interact.Action action, java.lang.String name)
void	replaceAction(org.metacosm.framework.interact.Action action, java.lang.String[] names)
void	save(java.io.OutputStream os)           Saves on the stream.
java.lang.String	toString()           Convert this Object to a human-readable String.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

addedDescriptionProperties

private java.util.Map addedDescriptionProperties

DescriptionProperties for add

---

appendDescriptionProperties

private java.util.Map appendDescriptionProperties

DescriptionProperties for append

---

relativeModifiers

private java.util.Map relativeModifiers

Relative modifiers

---

absoluteModifiers

private java.util.Map absoluteModifiers

Absolute modifiers

---

properties

private java.util.Map properties

Newly defined Properties

---

addedActions

private java.util.Map addedActions

Actions added

---

replacedActions

private java.util.Map replacedActions

Actions replaced

---

name

private java.lang.String name

Influence name

Constructor Detail

Influence

public Influence(java.lang.String name)
          throws java.lang.IllegalArgumentException

Method Detail

isApplicableTo

public boolean isApplicableTo(BasicEntity entity)

---

addProperty

public void addProperty(org.metacosm.util.Property property)
                 throws AlreadyDefinedPropertyException

Defines a new Property.

---

removeProperty

public boolean removeProperty(org.metacosm.util.Property property)

Removes the Property.

---

removeProperty

public boolean removeProperty(java.lang.String name)

Removes the Property

---

getProperties

public java.util.Map getProperties()

---

modifyProperty

public void modifyProperty(java.lang.String name,
                           org.metacosm.util.AbsoluteModifier am)
                    throws UndefinedPropertyException

Modifies the Property name with the AbsoluteModifier am.

---

removeAbsoluteModifier

public void removeAbsoluteModifier(java.lang.String name)
                            throws UndefinedPropertyException

Removes the AbsoluteModifier am on the Property name.

---

modifyProperty

public void modifyProperty(java.lang.String name,
                           org.metacosm.util.RelativeModifier rm)
                    throws UndefinedPropertyException

Modifies the Property name with the RelativeModifier am.

---

getAbsoluteModifiers

public java.util.Map getAbsoluteModifiers()

---

getRelativeModifiers

public java.util.Map getRelativeModifiers()

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

addAction

public void addAction(org.metacosm.framework.interact.Action action,
                      java.lang.String name)
               throws AlreadyDefinedActionException

---

addAction

public void addAction(org.metacosm.framework.interact.Action action,
                      java.lang.String[] names)
               throws AlreadyDefinedActionException

---

replaceAction

public void replaceAction(org.metacosm.framework.interact.Action action,
                          java.lang.String name)
                   throws UndefinedActionException

---

replaceAction

public void replaceAction(org.metacosm.framework.interact.Action action,
                          java.lang.String[] names)
                   throws UndefinedActionException

---

removeAction

public boolean removeAction(org.metacosm.framework.interact.Action action)

---

removeAction

public boolean removeAction(java.lang.String name)

---

getAction

public org.metacosm.framework.interact.Action getAction(java.lang.String actionId)

---

getAddedActions

public java.util.Map getAddedActions()

---

getReplacedActions

public java.util.Map getReplacedActions()

---

addDescription

public void addDescription(DescriptionProperty d)

Adds a new DescriptionProperty to describe the Entity. Replaces a preexistent DescriptionProperty with the same name if it exists.

---

appendDescription

public void appendDescription(DescriptionProperty d)

Appends the value of the DescriptionProperty to a preexistent one with the same name. Adds a new DescriptionProperty if no one preexists

---

getAddedDescriptions

public java.util.Map getAddedDescriptions()

---

getAppendDescriptions

public java.util.Map getAppendDescriptions()

---

getName

public final java.lang.String getName()

---

save

public void save(java.io.OutputStream os)
          throws java.io.IOException

Description copied from interface: org.metacosm.framework.persistence.Persistent

Saves on the stream.

Specified by:

save in interface org.metacosm.framework.persistence.Persistent

---

load

public void load(java.io.InputStream is)
          throws java.io.IOException

Description copied from interface: org.metacosm.framework.persistence.Persistent

Loads from the stream.

Specified by:

load in interface org.metacosm.framework.persistence.Persistent

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> metacosm >> framework >> [ entity overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---