PhantomHostData (NetPhantom(R) 5.5 Java API documentation)

java.lang.Object
- se.entra.phantom.server.PhantomHostData

All Implemented Interfaces:

IReloadable
```
public class PhantomHostData
extends Object
implements IReloadable
```
This class loads the Phantom Host file containing screens and macros.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`PhantomHostData.ScreenGroup` This class is used by the PhantomHostData class to maintain screen groups when screen are using the binary match method.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`areScreensAnalyzed` Flag indicating if the screens are analyzed so that "binary" search algorithm can be used.
`static String`	`BROKEN_MACRO_SCREEN_NAME` The name of the dummy screen used "__BROKEN_MACRO__".
`static PhantomHostScreen`	`dummyScreen` A dummy host screen when a Phantom Macro is broken.
`Hashtable<String,PhantomHostScreen>`	`fastSearch` The hash table for the screen groups instead of the binary search algorithm.
`String`	`fileComments` The file comments.
`int`	`macroCount` Count of Phantom macros.
`Hashtable<String,PhantomMacro>`	`macros` The table of macros.
`static int`	`MATCHFLAG_POPWIN` Match flag: Use pop-up window recognition.
`static int`	`MATCHFLAG_STOPWHENFOUND` Match flag: Stop at first match.
`int`	`matchFlags` Flags used for matching screens.
`PhantomRuntime`	`runtime` The runtime file associated with the host data, null for none.
`int`	`screenCount` Count of host screens.
`PhantomHostData.ScreenGroup[]`	`screenGroups` The screen group array.
`Vector<PhantomHostScreen>`	`screens` The host screen array.
`Hashtable<String,PhantomHostScreen>`	`screensByName` Table to find a screen by the name.
`boolean`	`useBinaryMatchMethod` Flag for searching the screens using binary search algorithm.

Fields inherited from interface se.entra.phantom.server.IReloadable
FAILURE, NOTHING_DONE, SUCCESS

Constructor Summary

Constructors
Constructor and Description
`PhantomHostData()` Creates an empty host data instance.
`PhantomHostData(PhantomFile file)` Constructor - loads the indicated file.
`PhantomHostData(PhantomFile file, PhantomRuntime runtime)` Constructor - loads the indicated file (if non-null), an associated runtime (that may be null).

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(PhantomHostScreen newScreen)` Add a new screen.
`PhantomHostScreen`	`addBrokenMacroScreen()` Adds the broken dummy screen to the application once only.
`PhantomHostScreen[]`	`getAllMatchingScreens(HostScreen screen)` Find all the screens that match.
`String`	`getFileName()` Gets file name.
`PhantomMacro`	`getMacro(String name)` Gets a macro by the name.
`Hashtable<String,PhantomMacro>`	`getMacros()` Gets macros for this host data
`PhantomHostScreen`	`getMatchingScreen(HostScreen screen)` Checks which screens match.
`int[]`	`getMatchingScreens(HostScreen screen)` Gets the matching screens for this runtime file host data with the current settings.
`PhantomHostScreen`	`getScreen(int index)` Gets a host screen from index.
`PhantomHostScreen`	`getScreen(String name)` Gets a host screen by the name.
`PhantomHostScreen[]`	`getScreens()` Gets screens for this host data.
`void`	`maybeThrowIOException(String msg)` Throws an IOException with the message specified if the runtime file is loaded normally and doesn't have the flag doIgnoreNonFatalErrors set.
`boolean`	`needsReload()` Check if this file needs to be reloaded.
`int`	`reload(boolean force)` Reload internal state from external sources.
`boolean`	`remove(String screenName)` Delete a screen.
`void`	`removeAllMacros()` Removes all macros.
`boolean`	`rename(String oldName, String newName)` Renames a host screen, the reference of the PhantomHostScreen gets the name changed and the hash table containing String names to PhantomHostScreen is updated.
`void`	`save(PhantomOutputFile file)` Save the host data to file.
`void`	`save(String fileName)` Save the host data to file.

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

- Field Detail
  - MATCHFLAG_STOPWHENFOUND
```
public static final int MATCHFLAG_STOPWHENFOUND
```
    Match flag: Stop at first match.
    
    See Also:
    Constant Field Values
  - MATCHFLAG_POPWIN
```
public static final int MATCHFLAG_POPWIN
```
    Match flag: Use pop-up window recognition.
    
    See Also:
    Constant Field Values
  - screenCount
```
public int screenCount
```
    Count of host screens.
  - areScreensAnalyzed
```
public boolean areScreensAnalyzed
```
    Flag indicating if the screens are analyzed so that "binary" search algorithm can be used.
  - matchFlags
```
public int matchFlags
```
    Flags used for matching screens.
  - useBinaryMatchMethod
```
public boolean useBinaryMatchMethod
```
    Flag for searching the screens using binary search algorithm. For the Java Server, a hash table is used instead, because it's faster.
  - screenGroups
```
public PhantomHostData.ScreenGroup[] screenGroups
```
    The screen group array.
  - fastSearch
```
public Hashtable<String,PhantomHostScreen> fastSearch
```
    The hash table for the screen groups instead of the binary search algorithm. The key for this array is a string where the first character is the screen group index followed by the screen matching data (ID_EXACT). The last screen group is not using this technique, so it is not included in this table.
  - screens
```
public Vector<PhantomHostScreen> screens
```
    The host screen array.
  - screensByName
```
public Hashtable<String,PhantomHostScreen> screensByName
```
    Table to find a screen by the name.
  - macroCount
```
public int macroCount
```
    Count of Phantom macros.
  - macros
```
public Hashtable<String,PhantomMacro> macros
```
    The table of macros.
  - BROKEN_MACRO_SCREEN_NAME
```
public static final String BROKEN_MACRO_SCREEN_NAME
```
    The name of the dummy screen used "__BROKEN_MACRO__".
    
    See Also:
    Constant Field Values
  - dummyScreen
```
public static final PhantomHostScreen dummyScreen
```
    A dummy host screen when a Phantom Macro is broken. It will warn and refer to this screen instead. This screen never matches due to its size (40x12) and no host has such a screen size.
  - runtime
```
public PhantomRuntime runtime
```
    The runtime file associated with the host data, null for none.
  - fileComments
```
public String fileComments
```
    The file comments.
- Constructor Detail
  - PhantomHostData
```
public PhantomHostData()
```
    Creates an empty host data instance. It is documented to perhaps throw an IOException, but it never does!
  - PhantomHostData
```
public PhantomHostData(PhantomFile file)
                throws IOException
```
    Constructor - loads the indicated file.
    
    Throws:
    
    IOException
  - PhantomHostData
```
public PhantomHostData(PhantomFile file,
               PhantomRuntime runtime)
                throws IOException
```
    Constructor - loads the indicated file (if non-null), an associated runtime (that may be null).
    
    Throws:
    
    IOException
- Method Detail
  - maybeThrowIOException
```
public void maybeThrowIOException(String msg)
                           throws IOException
```
    Throws an IOException with the message specified if the runtime file is loaded normally and doesn't have the flag doIgnoreNonFatalErrors set. If it is not thrown, a message is logged in the event log.
    
    Throws:
    
    IOException
  - addBrokenMacroScreen
```
public PhantomHostScreen addBrokenMacroScreen()
```
    Adds the broken dummy screen to the application once only.
  - add
```
public boolean add(PhantomHostScreen newScreen)
```
    Add a new screen. The same screen name cannot be used twice.
    
    Parameters:
    PhantomHostScreen -
    
    Returns:
    boolean - successful or not
  - remove
```
public boolean remove(String screenName)
```
    Delete a screen.
    
    Parameters:
    String - screen name
    
    Returns:
    boolean - successful or not
  - rename
```
public boolean rename(String oldName,
             String newName)
```
    Renames a host screen, the reference of the PhantomHostScreen gets the name changed and the hash table containing String names to PhantomHostScreen is updated.
    
    Returns:
    true for success, false if the screen is not found or the new name is taken.
  - getMacros
```
public Hashtable<String,PhantomMacro> getMacros()
```
    Gets macros for this host data
    
    Returns:
    null if the screen is not found.
  - getScreens
```
public PhantomHostScreen[] getScreens()
```
    Gets screens for this host data.
  - getScreen
```
public PhantomHostScreen getScreen(String name)
```
    Gets a host screen by the name.
    
    Returns:
    null if the screen is not found.
  - getFileName
```
public String getFileName()
```
    Gets file name.
    
    Returns:
    String - null if the file stamp is not used.
  - getScreen
```
public PhantomHostScreen getScreen(int index)
```
    Gets a host screen from index.
    
    Returns:
    null if the screen is not found.
  - getMacro
```
public PhantomMacro getMacro(String name)
```
    Gets a macro by the name.
    
    Returns:
    null if the macro is not found.
  - getMatchingScreens
```
public int[] getMatchingScreens(HostScreen screen)
```
    Gets the matching screens for this runtime file host data with the current settings.
    A maximum of 256 screens is quite OK, if more, there is a big error in the application.
    
    Returns:
    null if no screen matches.
  - getAllMatchingScreens
```
public PhantomHostScreen[] getAllMatchingScreens(HostScreen screen)
```
    Find all the screens that match.
    
    Returns:
    null If none of the screens match.
  - getMatchingScreen
```
public PhantomHostScreen getMatchingScreen(HostScreen screen)
```
    Checks which screens match.
    
    Returns:
    null If none or more than one screen matches.
  - save
```
public void save(String fileName)
          throws IOException
```
    Save the host data to file.
    
    Parameters:
    fileName -
    
    Throws:
    
    IOException
  - save
```
public void save(PhantomOutputFile file)
          throws IOException
```
    Save the host data to file.
    
    Parameters:
    fileName -
    
    Throws:
    
    IOException
  - needsReload
```
public boolean needsReload()
```
    Check if this file needs to be reloaded.
    
    Specified by:
    
    needsReload in interface IReloadable
    
    Returns:
    boolean
  - reload
```
public int reload(boolean force)
           throws IOException
```
    Reload internal state from external sources.
    
    Specified by:
    
    reload in interface IReloadable
    
    Parameters:
    force - - force the reload.
    
    Returns:
    int
    
    Throws:
    
    IOException
  - removeAllMacros
```
public void removeAllMacros()
```
    Removes all macros.

Class PhantomHostData

Nested Class Summary

Field Summary

Fields inherited from interface se.entra.phantom.server.IReloadable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MATCHFLAG_STOPWHENFOUND

MATCHFLAG_POPWIN

screenCount

areScreensAnalyzed

matchFlags

useBinaryMatchMethod

screenGroups

fastSearch

screens

screensByName

macroCount

macros

BROKEN_MACRO_SCREEN_NAME

dummyScreen

runtime

fileComments

Constructor Detail

PhantomHostData

PhantomHostData

PhantomHostData

Method Detail

maybeThrowIOException

addBrokenMacroScreen

add

remove

rename

getMacros

getScreens

getScreen

getFileName

getScreen

getMacro

getMatchingScreens

getAllMatchingScreens

getMatchingScreen

save

save

needsReload

reload

removeAllMacros