ActorMetadata

java.lang.Object
- org.kepler.objectmanager.ActorMetadata

All Implemented Interfaces:: java.io.Serializable

Direct Known Subclasses:: GraphicalActorMetadata

public class ActorMetadata
extends java.lang.Object
implements java.io.Serializable

This class parses and contains metadata for an actor. this creates an entity of the form:

 <entity name="Constant">
     <property name="documentation" class="ptolemy.vergil.basic.KeplerDocumentationAttribute">
     actor to provide constant input
     </property>
     <property name="entityId" class="org.kepler.moml.NamedObjId"
                     value="urn:lsid:lsid.ecoinformatics.org:actor:101:1"/>
     <property name="class" value="org.kepler.actor.TestActor"
               class="ptolemy.kernel.util.StringAttribute">
       <property name="id" value="urn:lsid:lsid.ecoinformatics.org:actor:1001:1"
                 class="ptolemy.kernel.util.StringAttribute"/>
     </property>
     <property name="output" class="org.kepler.moml.PortProperty>
       <property name="direction" value="output" class="ptolemy.kernel.util.StringAttribute"/>
       <property name="dataType" value="unknown" class="ptolemy.kernel.util.StringAttribute"/>
       <property name="isMultiport" value="false" class="ptolemy.kernel.util.StringAttribute"/>
     </property>
     <property name="trigger" class="org.kepler.moml.PortProperty>
       <property name="direction" value="input" class="ptolemy.kernel.util.StringAttribute"/>
       <property name="dataType" value="unknown" class="ptolemy.kernel.util.StringAttribute"/>
       <property name="isMultiport" value="true" class="ptolemy.kernel.util.StringAttribute"/>
     </property>
     <property class="org.kepler.sms.SemanticType" name="semanticType" value="urn:lsid:lsid.ecoinformatics.org:onto:1:1#ConstantActor"/>
     <property class="org.kepler.moml.Dependency" name="dependency" value="urn:lsid:lsid.ecoinformatics.org:nativeLib:1:1"/>
     </entity>

Note: As of 8/18/09, this class no longer includes graphical ammentities, such as icons in the moml. If you want graphical widgets for your actor, you must use org.kepler.gui.GraphicalActorMetadata.

Author:: Chad Berkley
See Also:: Serialized Form
Created:: April 07, 2005

Constructor Summary

Constructors
Constructor and Description
`ActorMetadata()` default constructor. this is for serialization only. do not use this.
`ActorMetadata(java.io.InputStream moml)` Constructor.
`ActorMetadata(NamedObj obj)` builds a new ActorMetadata object from an existing NamedObj

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(Attribute a)` add a generic attribute to this actorMetadata object.
`void`	`addDependency(java.lang.String id)` add the id of a dependency to the metadata
`void`	`addMetadataHandler(MetadataHandler handler)` this method allows other classes to add handlers to further process the metadata produced by this class.
`void`	`addRelation(ComponentRelation r)` add a relation
`void`	`addSemanticType(java.lang.String name, java.lang.String id)` add the id of a semantic type to the metadata
`static NamedObj`	`createInstance(java.lang.Class<?> newClass, java.lang.Object[] arguments)` createInstance. creates an instance of a class object. taken from ptolemy's MomlParser class. modified for this application.
`NamedObj`	`getActor()` return the actor this object was built from.
`NamedObj`	`getActorAsNamedObj(CompositeEntity container)` return this actor as a ComponentEntity
`boolean`	`getChanged()` get the changed flag. this is useful for keeping track of the state of the actor metadata. this flag does not affect this class in any internal way except for setting the flag.
`java.lang.String`	`getClassId()` return the id of the class
`java.lang.String`	`getClassName()` return the classname of the actor object. this will be the java type classname no matter what kind of actor we are describing. for instance if it is a java class, it will be a.b.c.ClassName where the file is stored in a/b/c/ClassName.class.
`java.util.Vector<java.lang.String>`	`getDependencies()` return a vector of the ids of the semantic type reference
`KeplerDocumentationAttribute`	`getDocumentationAttribute()`
`java.lang.String`	`getId()` return the lsid of the actor class object
`java.lang.String`	`getInternalClassName()` return the internal class name of the actor object. for composites this will be ptolemy.actor.TypedCompositeActor.
`KeplerLSID`	`getLSID()` returns the id of this object as a KeplerLSID
`java.lang.String`	`getName()` return the name of the actor
`java.util.Hashtable<java.lang.String,java.lang.String>`	`getSemanticTypeHash()`
`java.util.Vector<java.lang.String>`	`getSemanticTypes()` return a vector of the ids of the semantic type reference
`protected ComponentEntity`	`parseMoMLFile(java.lang.String className)` try to locate and parse a moml file as a class
`void`	`removeMetadataHandler(MetadataHandler handler)` remove a metadata handler
`void`	`removeSemanticType(java.lang.String id)`
`protected java.io.File`	`searchClasspath(java.lang.String className)` search the classpath for a specific class and return the file.
`void`	`setActor(NamedObj actor)`
`void`	`setChanged(boolean b)` set the changed flag. this is useful for keeping track of the state of the actor metadata. this flag does not affect this class in any internal way except for setting the flag.
`void`	`setClassId(java.lang.String id)`
`void`	`setDocumentationAttribute(KeplerDocumentationAttribute newda)`
`void`	`setId(java.lang.String id)` set the id
`void`	`setName(java.lang.String name)` set the name
`java.lang.String`	`toString()` return the moml xml representation of the actor.
`java.lang.String`	`toString(boolean addSuffixToSemanticTypeNames, boolean includeAttributes, boolean includePorts)` return the moml xml representation of the actor.

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

- Constructor Detail
  - ActorMetadata
```
public ActorMetadata()
```
    default constructor. this is for serialization only. do not use this.
  - ActorMetadata
```
public ActorMetadata(java.io.InputStream moml)
              throws InvalidMetadataException
```
    Constructor. Takes in xml metadata. This should be a moml entity with the kepler additional metadata properties. The entity is parsed and an ActorMetadata object is created with appropriate fields.
    
    Parameters:
    
    moml - the xml metadata
    
    Throws:
    
    InvalidMetadataException
  - ActorMetadata
```
public ActorMetadata(NamedObj obj)
```
    builds a new ActorMetadata object from an existing NamedObj
    
    Parameters:
    
    am - the ActorMetadata to build this object from.
- Method Detail
  - getActor
```
public NamedObj getActor()
```
    return the actor this object was built from.
  - setActor
```
public void setActor(NamedObj actor)
```
  - getName
```
public java.lang.String getName()
```
    return the name of the actor
  - setName
```
public void setName(java.lang.String name)
```
    set the name
  - getId
```
public java.lang.String getId()
```
    return the lsid of the actor class object
  - getLSID
```
public KeplerLSID getLSID()
                   throws java.lang.Exception
```
    returns the id of this object as a KeplerLSID
    
    Throws:
    
    java.lang.Exception
  - getDocumentationAttribute
```
public KeplerDocumentationAttribute getDocumentationAttribute()
```
  - setDocumentationAttribute
```
public void setDocumentationAttribute(KeplerDocumentationAttribute newda)
                               throws IllegalActionException,
                                      NameDuplicationException,
                                      java.lang.CloneNotSupportedException
```
    Throws:
    
    IllegalActionException
    
    NameDuplicationException
    
    java.lang.CloneNotSupportedException
  - setId
```
public void setId(java.lang.String id)
```
    set the id
  - getClassName
```
public java.lang.String getClassName()
```
    return the classname of the actor object. this will be the java type classname no matter what kind of actor we are describing. for instance if it is a java class, it will be a.b.c.ClassName where the file is stored in a/b/c/ClassName.class. If it is a MoML class, it will be a.b.c.MomlClassName where the file is a/b/c/MomlClassName.xml
  - getInternalClassName
```
public java.lang.String getInternalClassName()
```
    return the internal class name of the actor object. for composites this will be ptolemy.actor.TypedCompositeActor. For atomics, it will be the full java class name.
  - getClassId
```
public java.lang.String getClassId()
```
    return the id of the class
  - setClassId
```
public void setClassId(java.lang.String id)
```
  - addDependency
```
public void addDependency(java.lang.String id)
```
    add the id of a dependency to the metadata
    
    Parameters:
    
    id - the id of the dependency to add
  - addSemanticType
```
public void addSemanticType(java.lang.String name,
                            java.lang.String id)
```
    add the id of a semantic type to the metadata
    
    Parameters:
    
    id - the id of the semantic type to add
  - getSemanticTypes
```
public java.util.Vector<java.lang.String> getSemanticTypes()
```
    return a vector of the ids of the semantic type reference
  - getSemanticTypeHash
```
public java.util.Hashtable<java.lang.String,java.lang.String> getSemanticTypeHash()
```
  - removeSemanticType
```
public void removeSemanticType(java.lang.String id)
```
  - getDependencies
```
public java.util.Vector<java.lang.String> getDependencies()
```
    return a vector of the ids of the semantic type reference
  - getChanged
```
public boolean getChanged()
```
    get the changed flag. this is useful for keeping track of the state of the actor metadata. this flag does not affect this class in any internal way except for setting the flag.
  - setChanged
```
public void setChanged(boolean b)
```
    set the changed flag. this is useful for keeping track of the state of the actor metadata. this flag does not affect this class in any internal way except for setting the flag.
    
    Parameters:
    
    b -
  - addAttribute
```
public void addAttribute(Attribute a)
```
    add a generic attribute to this actorMetadata object.
    
    Parameters:
    
    a - the attribute to add
  - addRelation
```
public void addRelation(ComponentRelation r)
```
    add a relation
  - getActorAsNamedObj
```
public NamedObj getActorAsNamedObj(CompositeEntity container)
                            throws java.lang.Exception
```
    return this actor as a ComponentEntity
    
    Parameters:
    
    container - the new ComponentEntity's container
    
    Throws:
    
    java.lang.Exception
  - toString
```
public java.lang.String toString()
```
    return the moml xml representation of the actor.
    
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(boolean addSuffixToSemanticTypeNames,
                                 boolean includeAttributes,
                                 boolean includePorts)
```
    return the moml xml representation of the actor.
    
    Parameters:
    
    incSemanticTypeNames - if true, add a suffix to property names for semantic types, e.g. semanticType00 -> semanticType000
    
    includeAttributes - if true, add the attributes and parameters to the xml representation. this flag does not affect semantic types or documentation attributes.
    
    includePorts - if true, add the ports to the xml representation.
  - addMetadataHandler
```
public void addMetadataHandler(MetadataHandler handler)
```
    this method allows other classes to add handlers to further process the metadata produced by this class. The handlers will be called in the getActorAsNamedObj() and getActorClass() methods.
    
    Parameters:
    
    handler - the handler to add
  - removeMetadataHandler
```
public void removeMetadataHandler(MetadataHandler handler)
```
    remove a metadata handler
    
    Parameters:
    
    handler - the handler to remove
  - searchClasspath
```
protected java.io.File searchClasspath(java.lang.String className)
                                throws java.io.FileNotFoundException
```
    search the classpath for a specific class and return the file. In the tradition of ptolemy, this will also search for moml files with a class definition. this is required for composite actors.
    
    Parameters:
    
    className - the name of the class to search for
    
    workDir - the directory where temp files can be created
    
    Throws:
    
    java.io.FileNotFoundException
  - parseMoMLFile
```
protected ComponentEntity parseMoMLFile(java.lang.String className)
                                 throws java.lang.Exception
```
    try to locate and parse a moml file as a class
    
    Throws:
    
    java.lang.Exception
  - createInstance
```
public static NamedObj createInstance(java.lang.Class<?> newClass,
                                      java.lang.Object[] arguments)
                               throws java.lang.Exception
```
    createInstance. creates an instance of a class object. taken from ptolemy's MomlParser class. modified for this application.
    
    Parameters:
    
    newClass -
    
    arguments -
    
    Returns:
    
    TypedAtomicActor
    
    Throws:
    
    java.lang.Exception

Class ActorMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ActorMetadata

ActorMetadata

ActorMetadata

Method Detail

getActor

setActor

getName

setName

getId

getLSID

getDocumentationAttribute

setDocumentationAttribute

setId

getClassName

getInternalClassName

getClassId

setClassId

addDependency

addSemanticType

getSemanticTypes

getSemanticTypeHash

removeSemanticType

getDependencies

getChanged

setChanged

addAttribute

addRelation

getActorAsNamedObj

toString

toString

addMetadataHandler

removeMetadataHandler

searchClasspath

parseMoMLFile

createInstance