Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.grouping.critters
Class ProtoCritterType

java.lang.Object
  extended by org.hyperic.hq.grouping.critters.BaseCritterType
      extended by org.hyperic.hq.grouping.critters.ProtoCritterType
All Implemented Interfaces:
CritterType

public class ProtoCritterType
extends BaseCritterType

Metadata for ProtoCritter which matches all Prototypes in EAM_RESOURCE by proto_id


Nested Class Summary
 class ProtoCritterType.ProtoCritter
          Fetches all the Prototypes from EAM_RESOURCE by proto_id
 
Constructor Summary
ProtoCritterType()
           
ProtoCritterType(boolean system)
           
 
Method Summary
 Critter compose(CritterDump dump)
          Returns a Critter instance of this critter type based on the critter properties passed through in the CritterDump.
 void decompose(Critter critter, CritterDump dump)
          Returns a Critter instance of this critter type based on the critter properties passed through in the CritterDump.
 boolean isSystem()
          Return true if the Critter is an internal one and used by the system.
 boolean isUserVisible()
          returns true if this critter should be visible to the UI for user-defined org.hyperic.hq.groupingCritterLists.
 Critter newInstance(java.util.Map critterProps)
          Create a new instance of this critter type.
 ProtoCritterType.ProtoCritter newInstance(Resource name)
           
 
Methods inherited from class org.hyperic.hq.grouping.critters.BaseCritterType
addEnumPropDescription, addPropDescription, addPropDescription, getBundle, getDescription, getInstanceConfig, getName, getPropDescriptions, getResourceProperty, initialize, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProtoCritterType

public ProtoCritterType(boolean system)

ProtoCritterType

public ProtoCritterType()
Method Detail

compose

public Critter compose(CritterDump dump)
                throws GroupException
Description copied from interface: CritterType
Returns a Critter instance of this critter type based on the critter properties passed through in the CritterDump.

Parameters:
dump - The CritterDump containing the critter properties used to populate the new Critter instance.
Throws:
GroupException

decompose

public void decompose(Critter critter,
                      CritterDump dump)
               throws GroupException
Description copied from interface: CritterType
Returns a Critter instance of this critter type based on the critter properties passed through in the CritterDump.

dump - The Critter instance from which the critter properties will be read to populate the CritterDump.
Throws:
GroupException

isUserVisible

public boolean isUserVisible()
Description copied from interface: CritterType
returns true if this critter should be visible to the UI for user-defined org.hyperic.hq.groupingCritterLists.


isSystem

public boolean isSystem()
Description copied from interface: CritterType
Return true if the Critter is an internal one and used by the system. Critters with this set should not be persisted. In addition, system-based criteria MUST be matched when processing the results. i.e. a CriterList may specify that 'any' may match, but if it contains a system critter, it MUST match. Essentially this will SQL "and" this CritterType in the CritterList to the other members no matter the value of CritterList.isAny(). Example uses: - Critters that specify a match for compatable groups - Critters that filter out system-related resources (virtual servers)


newInstance

public ProtoCritterType.ProtoCritter newInstance(Resource name)

newInstance

public Critter newInstance(java.util.Map critterProps)
                    throws GroupException
Description copied from interface: CritterType
Create a new instance of this critter type. The passed props must match what the type is asking for (via getPropDescriptions())

Parameters:
critterProps - a map of prop IDs onto the actual props. The keys must match ids of props as returned by CritterProp.getId()
Throws:
GroupException

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.